Skip to content

Commit c5f1277

Browse files
committed
Report API for SMS campaigns updates & other mixed changes
1 parent 297696b commit c5f1277

27 files changed

+113
-50
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ISC License
22

3-
Copyright (c) 2018, SendinBlue
3+
Copyright (c) 2019, SendinBlue
44

55
Permission to use, copy, modify, and/or distribute this software for any
66
purpose with or without fee is hereby granted, provided that the above

docs/CreateWebhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**url** | **String** | URL of the webhook |
77
**description** | **String** | Description of the webhook | [optional]
8-
**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]
8+
**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 |
99
**type** | **String** | Type of the webhook | [optional] [default to 'transactional']
1010

1111

docs/GetSmsEventReportEvents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**phoneNumber** | **String** | Phone number which has generated the event |
7-
**_date** | **Date** | Date on which the event has been generated |
7+
**_date** | **Date** | UTC date-time on which the event has been generated |
88
**messageId** | **String** | Message ID which generated the event |
99
**event** | **String** | Event which occurred |
1010
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]

docs/RequestContactImport.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
1111
**emailBlacklist** | **Boolean** | To blacklist all the contacts for email | [optional] [default to false]
1212
**smsBlacklist** | **Boolean** | To blacklist all the contacts for sms | [optional] [default to false]
1313
**updateExistingContacts** | **Boolean** | To facilitate the choice to update the existing contacts | [optional] [default to true]
14+
**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]
1415

1516

docs/RequestSmsRecipientExport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**notifyURL** | **String** | URL that will be called once the export process is finished | [optional]
7-
**recipientsType** | **String** | Filter the recipients based on how they interacted with the campaign | [default to 'all']
7+
**recipientsType** | **String** | Filter the recipients based on how they interacted with the campaign |
88

99

1010
<a name="RecipientsTypeEnum"></a>

docs/SMSCampaignsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ null (empty response body)
377377

378378
<a name="sendTestSms"></a>
379379
# **sendTestSms**
380-
> sendTestSms(campaignId, sendTestSms)
380+
> sendTestSms(campaignId, phoneNumber)
381381
382382
Send an SMS
383383

@@ -396,9 +396,9 @@ var apiInstance = new SibApiV3Sdk.SMSCampaignsApi();
396396

397397
var campaignId = 789; // Number | Id of the SMS campaign
398398

399-
var sendTestSms = new SibApiV3Sdk.SendTestSms(); // SendTestSms | Mobile number to which send the test
399+
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
400400

401-
apiInstance.sendTestSms(campaignId, sendTestSms).then(function() {
401+
apiInstance.sendTestSms(campaignId, phoneNumber).then(function() {
402402
console.log('API called successfully.');
403403
}, function(error) {
404404
console.error(error);
@@ -411,7 +411,7 @@ apiInstance.sendTestSms(campaignId, sendTestSms).then(function() {
411411
Name | Type | Description | Notes
412412
------------- | ------------- | ------------- | -------------
413413
**campaignId** | **Number**| Id of the SMS campaign |
414-
**sendTestSms** | [**SendTestSms**](SendTestSms.md)| Mobile number to which send the test |
414+
**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 |
415415

416416
### Return type
417417

docs/SendReportEmail.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**subject** | **String** | Subject of the email message | [optional]
7-
**to** | **[String]** | Email addresses of the recipients | [optional]
8-
**contentType** | **String** | Type of the message body | [optional]
6+
**subject** | **String** | Subject of the email message |
7+
**to** | **[String]** | Email addresses of the recipients |
8+
**contentType** | **String** | Type of the message body | [optional] [default to &#39;html&#39;]
99
**bcc** | **[String]** | Email addresses of the recipients in bcc | [optional]
1010
**cc** | **[String]** | Email addresses of the recipients in cc | [optional]
11-
**body** | **String** | Body of the email message | [optional]
11+
**body** | **String** | Body of the email message |
1212

1313

1414
<a name="ContentTypeEnum"></a>

docs/SendSms.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**reference** | **String** | |
77
**messageId** | **Number** | |
8+
**smsCount** | **Number** | Count of SMS&#39;s to send multiple text messages | [optional]
9+
**usedCredits** | **Number** | SMS credits used per text message | [optional]
10+
**remainingCredits** | **Number** | Remaining SMS credits of the user | [optional]
811

912

docs/SendSmtpEmail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**textContent** | **String** | Plain Text body of the message ( Ignored if &#39;templateId&#39; is passed ) | [optional]
1212
**subject** | **String** | Subject of the message. Mandatory if &#39;templateId&#39; is not passed | [optional]
1313
**replyTo** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14-
**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]
14+
**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]
1515
**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]
1616
**templateId** | **Number** | Id of the template | [optional]
1717
**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]

docs/SendTestSms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**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]
6+
**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]
77

88

0 commit comments

Comments
 (0)