Skip to content

Commit 297696b

Browse files
authored
Merge pull request #45 from sendinblue/feature_new-changes
Mixed changes for different definitions
2 parents 2971b57 + f604016 commit 297696b

29 files changed

+80
-53
lines changed

docs/CreateEmailCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
2222
**footer** | **String** | Footer of the email campaign | [optional]
2323
**header** | **String** | Header of the email campaign | [optional]
2424
**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]
25-
**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]
25+
**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]
2626

2727

2828
<a name="TypeEnum"></a>

docs/CreateSmsCampaign.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
**name** | **String** | Name of the campaign |
77
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
8-
**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]
8+
**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 |
99
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
1010
**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]
1111

docs/CreateSmsCampaignRecipients.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**listIds** | **[Number]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
7-
**exclusionListIds** | **[Number]** | List ids which have to be excluded from a campaign |
7+
**exclusionListIds** | **[Number]** | List ids which have to be excluded from a campaign | [optional]
88

99

docs/GetAggregatedReport.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
1515
**spamReports** | **Number** | Number of complaint (spam report) for the timeframe |
1616
**blocked** | **Number** | Number of blocked contact emails for the timeframe |
1717
**invalid** | **Number** | Number of invalid emails for the timeframe |
18+
**unsubscribed** | **Number** | Number of unsubscribed emails for the timeframe |
1819

1920

docs/GetEmailEventReportEvents.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Name | Type | Description | Notes
4141

4242
* `blocked` (value: `"blocked"`)
4343

44+
* `unsubscribed` (value: `"unsubscribed"`)
45+
4446

4547

4648

docs/GetReportsReports.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
1515
**spamReports** | **Number** | Number of complaints (spam reports) for the date |
1616
**blocked** | **Number** | Number of blocked emails for the date |
1717
**invalid** | **Number** | Number of invalid emails for the date |
18+
**unsubscribed** | **Number** | Number of unsubscribed emails for the date |
1819

1920

docs/GetSmsCampaignOverview.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
88
**status** | **String** | Status of the SMS Campaign |
99
**content** | **String** | Content of the SMS Campaign |
1010
**scheduledAt** | **Date** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
11-
**testSent** | **Boolean** | Retrieved the status of test SMS sending. (true&#x3D;Test SMS has been sent false&#x3D;Test SMS has not been sent) |
1211
**sender** | **String** | Sender of the SMS Campaign |
1312
**createdAt** | **Date** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1413
**modifiedAt** | **Date** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
@@ -28,7 +27,7 @@ Name | Type | Description | Notes
2827

2928
* `suspended` (value: `"suspended"`)
3029

31-
* `in_process` (value: `"in_process"`)
30+
* `inProcess` (value: `"inProcess"`)
3231

3332

3433

docs/SMSCampaignsApi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,8 @@ var apiInstance = new SibApiV3Sdk.SMSCampaignsApi();
184184

185185
var opts = {
186186
'status': "status_example", // String | Status of campaign.
187+
'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' )
188+
'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' )
187189
'limit': 500, // Number | Number limitation for the result returned
188190
'offset': 0 // Number | Beginning point in the list to retrieve from.
189191
};
@@ -200,6 +202,8 @@ apiInstance.getSmsCampaigns(opts).then(function(data) {
200202
Name | Type | Description | Notes
201203
------------- | ------------- | ------------- | -------------
202204
**status** | **String**| Status of campaign. | [optional]
205+
**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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
206+
**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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; ) | [optional]
203207
**limit** | **Number**| Number limitation for the result returned | [optional] [default to 500]
204208
**offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]
205209

docs/SendEmail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**replyTo** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
1010
**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]
1111
**attachment** | [**[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{&#39;content&#39;:&#39;base64 encoded content 1&#39;, &#39;name&#39;:&#39;attcahment1&#39;}, {&#39;content&#39;:&#39;base64 encoded content 2&#39;, &#39;name&#39;:&#39;attcahment2&#39;}]. | [optional]
12-
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;X-Mailin-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;X-Mailin-IP&#39;:&#39;1.2.3.4&#39;} | [optional]
12+
**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]
1313
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;} | [optional]
1414
**tags** | **[String]** | Tag your emails to find them more easily | [optional]
1515

docs/SendSmtpEmail.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
1212
**subject** | **String** | Subject of the message. Mandatory if &#39;templateId&#39; is not passed | [optional]
1313
**replyTo** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
1414
**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]
15-
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;X-Mailin-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;X-Mailin-IP&#39;:&#39;1.2.3.4&#39;} | [optional]
15+
**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]
17-
**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;}. | [optional]
17+
**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]
1818
**tags** | **[String]** | Tag your emails to find them more easily | [optional]
1919

2020

0 commit comments

Comments
 (0)