Skip to content

Commit 6df4b08

Browse files
aakanksha-sibaakanksha-sib
authored
Merge pull request #18 from sendinblue/feature_updated_swagger_sync
Swagger updates along with bug fixes and improvements
2 parents 0174150 + 6ff6a2f commit 6df4b08

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+269
-395
lines changed

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,6 @@ Class | Method | HTTP request | Description
243243
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
244244
- [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
245245
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
246-
- [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
247246
- [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
248247
- [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
249248
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)

‎docs/CreateAttribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
7-
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional]
8-
**type** | **String** | Type of the attribute. Use only if the attribute's category is normal, category or transactional ( type 'id' only available if the category is 'transactional' attribute & type 'category' only available if the category is 'category' attribute ) | [optional]
6+
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7+
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
8+
**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
99

1010

‎docs/CreateContact.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**email** | **String** | Email address of the user. Mandatory if `attributes.sms` is not passed | [optional]
7-
**attributes** | **Object** | Values of the attributes to fill. The attributes must exist in you contact database | [optional]
8-
**email_blacklisted** | **BOOLEAN** | Blacklist the contact for emails (emailBlacklisted = true) | [optional]
9-
**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
6+
**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
7+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
8+
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
9+
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1010
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
11-
**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
11+
**update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
1212
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
1313

1414

‎docs/CreateList.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
**name** | **String** | Name of the list |
7-
**folder_id** | **Integer** | Id of the folder in which to create the list |
7+
**folder_id** | **Integer** | Id of the parent folder in which this list is to be created |
88

99

‎docs/DeleteHardbounces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be lower than equal to endDate | [optional]
7-
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be greater than equal to startDate | [optional]
6+
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
7+
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
88
**contact_email** | **String** | Target a specific email address | [optional]
99

1010

‎docs/GetCampaignStats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)) | [optional]
6+
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional]
77
**unique_clicks** | **Integer** | Number of unique clicks for the campaign |
8-
**clickers** | **Integer** | Number of clicks for the campaign |
8+
**clickers** | **Integer** | Number of total clicks for the campaign |
99
**complaints** | **Integer** | Number of complaints (Spam reports) for the campaign |
1010
**delivered** | **Integer** | Number of delivered emails for the campaign |
1111
**sent** | **Integer** | Number of sent emails for the campaign |
@@ -14,6 +14,6 @@ Name | Type | Description | Notes
1414
**unique_views** | **Integer** | Number of unique openings for the campaign |
1515
**unsubscriptions** | **Integer** | Number of unsubscription for the campaign |
1616
**viewed** | **Integer** | Number of openings for the campaign |
17-
**deferred** | **Integer** | Number of deferred emails for the campaign |
17+
**deferred** | **Integer** | Number of deferred emails for the campaign | [optional]
1818

1919

‎docs/GetContactDetails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
1010
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
13-
**attributes** | **Hash<String, String>** | |
13+
**attributes** | **Object** | Set of attributes of the contact |
1414

1515

‎docs/GetExtendedCampaignStats.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**campaign_stats** | **Array<Object>** | |
6+
**global_stats** | **Object** | Overall statistics of the campaign |
7+
**campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. |
78
**mirror_click** | **Integer** | Number of clicks on mirror link |
89
**remaining** | **Integer** | Number of remaning emails to send |
9-
**links_stats** | [**Hash<String, GetExtendedCampaignStatsLinksStats>**](GetExtendedCampaignStatsLinksStats.md) | |
10+
**links_stats** | **Object** | Statistics about the number of clicks for the links |
1011
**stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) | |
1112

1213

‎docs/GetExtendedCampaignStatsLinksStats.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/GetExtendedContactDetails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
13-
**attributes** | **Hash<String, String>** | |
13+
**attributes** | **Object** | Set of attributes of the contact |
1414
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
1515

1616

‎docs/RequestContactExport.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**export_attributes** | **Array<String>** | Name of attributes to export. These attributes must be in your contact database | [optional]
7-
**contact_filter** | **Object** | Filter to apply to the export |
6+
**export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional]
7+
**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. |
88
**notify_url** | **String** | Webhook that will be called once the export process is finished | [optional]
99

1010

‎docs/RequestContactImport.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**file_url** | **String** | Mandatory if fileBody not defined. URL of the file to be imported (no local file). Possible file types: .txt, .csv | [optional]
6+
**file_url** | **String** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional]
77
**file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional]
8-
**list_ids** | **Array<Integer>** | Manadatory if newList is not defined. Ids of the lists in which to add the contacts | [optional]
8+
**list_ids** | **Array<Integer>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional]
99
**notify_url** | **String** | URL that will be called once the export process is finished | [optional]
1010
**new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional]
11+
**email_blacklist** | **BOOLEAN** | To blacklist all the contacts for email | [optional] [default to false]
12+
**sms_blacklist** | **BOOLEAN** | To blacklist all the contacts for sms | [optional] [default to false]
13+
**update_existing_contacts** | **BOOLEAN** | To facilitate the choice to update the existing contacts | [optional] [default to true]
1114

1215

‎docs/RequestContactImportNewList.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
**list_name** | **String** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional]
7-
**folder_id** | **Integer** | Folder id will be used with listName to make newly created list’s desired parent (Mandatory if listName is not empty). | [optional]
7+
**folder_id** | **Integer** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional]
88

99

‎docs/SMTPApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,8 @@ Name | Type | Description | Notes
482482
483483
Send a template
484484

485+
This endpoint is deprecated. Prefer v3/smtp/email instead.
486+
485487
### Example
486488
```ruby
487489
# load the gem

‎docs/SendEmail.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**email_to** | **Array<String>** | Email addresses of the recipients |
7-
**email_bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional]
8-
**email_cc** | **Array<String>** | Email addresses of the recipients in cc | [optional]
9-
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
6+
**email_to** | **Array<String>** | List of the email addresses of the recipients. For example, ['[email protected]', '[email protected]']. |
7+
**email_bcc** | **Array<String>** | List of the email addresses of the recipients in bcc | [optional]
8+
**email_cc** | **Array<String>** | List of the email addresses of the recipients in cc | [optional]
9+
**reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
1010
**attachment_url** | **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]
11-
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the base64 content of the attachment. 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]
12-
**headers** | **Hash<String, String>** | | [optional]
13-
**attributes** | **Hash<String, String>** | | [optional]
11+
**attachment** | [**Array<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]
12+
**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]
13+
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]
14+
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
1415

1516

‎docs/SendEmailAttachment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
7-
**name** | **String** | Required for content. Name of the attachment | [optional]
6+
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly |
7+
**name** | **String** | Required for content. Name of the attachment |
88

99

‎docs/SendSmtpEmail.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7-
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Email addresses and names of the recipients |
8-
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | Email addresses and names of the recipients in bcc | [optional]
9-
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | Email addresses and names of the recipients in cc | [optional]
7+
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'[email protected]'}, {'name':'Joe', 'email':'[email protected]'}] |
8+
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
9+
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
1010
**html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
1111
**text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
1212
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
1313
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14-
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. 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 ( Ignored if 'templateId' is passed ) | [optional]
15-
**headers** | **Hash<String, String>** | | [optional]
14+
**attachment** | [**Array<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]
15+
**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]
1616
**template_id** | **Integer** | Id of the template | [optional]
17-
**params** | **Hash<String, String>** | | [optional]
17+
**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
18+
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
1819

1920

‎docs/SendSmtpEmailAttachment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**url** | **String** | Absolute url of the attachment (no local file). | [optional]
77
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
8-
**name** | **String** | Required for content. Name of the attachment | [optional]
8+
**name** | **String** | Required if content is passed. Name of the attachment | [optional]
99

1010

‎docs/SendSmtpEmailSender.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **String** | Sender Name from which the emails are sent | [optional]
7-
**email** | **String** | Sender Email from which the emails are sent |
6+
**name** | **String** | Name of the sender from which the emails will be sent | [optional]
7+
**email** | **String** | Email of the sender from which the emails will be sent |
88

99

‎docs/SendTestEmail.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-
**email_to** | **Array<String>** | If empty the test email will be sent to your entire test list. Use this field to send it to specific addresses in your list. | [optional]
6+
**email_to** | **Array<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. | [optional]
77

88

0 commit comments

Comments
 (0)