Merge pull request #18 from sendinblue/feature_updated_swagger_sync

Swagger updates along with bug fixes and improvements

README.md

@@ -243,7 +243,6 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
  - [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
  - [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
- - [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
  - [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
  - [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
  - [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)

docs/CreateAttribute.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional] 
-**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional] 
-**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] 
+**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
+**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] 
+**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] 
 
 

docs/CreateContact.md

@@ -3,12 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** | Email address of the user. Mandatory if `attributes.sms` is not passed | [optional] 
-**attributes** | **Object** | Values of the attributes to fill. The attributes must exist in you contact database | [optional] 
-**email_blacklisted** | **BOOLEAN** | Blacklist the contact for emails (emailBlacklisted = true) | [optional] 
-**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
+**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional] 
+**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] 
+**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 
+**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
 **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 
-**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
+**update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
 **smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] 
 
 

docs/CreateList.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the list | 
-**folder_id** | **Integer** | Id of the folder in which to create the list | 
+**folder_id** | **Integer** | Id of the parent folder in which this list is to be created | 
 
 

docs/DeleteHardbounces.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
-**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] 
+**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] 
+**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] 
 **contact_email** | **String** | Target a specific email address | [optional] 
 
 

docs/GetCampaignStats.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)) | [optional] 
+**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional] 
 **unique_clicks** | **Integer** | Number of unique clicks for the campaign | 
-**clickers** | **Integer** | Number of clicks for the campaign | 
+**clickers** | **Integer** | Number of total clicks for the campaign | 
 **complaints** | **Integer** | Number of complaints (Spam reports) for the campaign | 
 **delivered** | **Integer** | Number of delivered emails for the campaign | 
 **sent** | **Integer** | Number of sent emails for the campaign | 
@@ -14,6 +14,6 @@ Name | Type | Description | Notes
 **unique_views** | **Integer** | Number of unique openings for the campaign | 
 **unsubscriptions** | **Integer** | Number of unsubscription for the campaign | 
 **viewed** | **Integer** | Number of openings for the campaign | 
-**deferred** | **Integer** | Number of deferred emails for the campaign | 
+**deferred** | **Integer** | Number of deferred emails for the campaign | [optional] 
 
 

docs/GetContactDetails.md

@@ -10,6 +10,6 @@ Name | Type | Description | Notes
 **modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **list_ids** | **Array<Integer>** |  | 
 **list_unsubscribed** | **Array<Integer>** |  | [optional] 
-**attributes** | **Hash<String, String>** |  | 
+**attributes** | **Object** | Set of attributes of the contact | 
 
 

docs/GetExtendedCampaignStats.md

@@ -3,10 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaign_stats** | **Array<Object>** |  | 
+**global_stats** | **Object** | Overall statistics of the campaign | 
+**campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. | 
 **mirror_click** | **Integer** | Number of clicks on mirror link | 
 **remaining** | **Integer** | Number of remaning emails to send | 
-**links_stats** | [**Hash<String, GetExtendedCampaignStatsLinksStats>**](GetExtendedCampaignStatsLinksStats.md) |  | 
+**links_stats** | **Object** | Statistics about the number of clicks for the links | 
 **stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) |  | 
 
 

docs/GetExtendedContactDetails.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **list_ids** | **Array<Integer>** |  | 
 **list_unsubscribed** | **Array<Integer>** |  | [optional] 
-**attributes** | **Hash<String, String>** |  | 
+**attributes** | **Object** | Set of attributes of the contact | 
 **statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) |  | 
 
 

docs/RequestContactExport.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**export_attributes** | **Array<String>** | Name of attributes to export. These attributes must be in your contact database | [optional] 
-**contact_filter** | **Object** | Filter to apply to the export | 
+**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] 
+**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. | 
 **notify_url** | **String** | Webhook that will be called once the export process is finished | [optional] 
 
 

docs/RequestContactImport.md

@@ -3,10 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file_url** | **String** | Mandatory if fileBody not defined. URL of the file to be imported (no local file). Possible file types: .txt, .csv | [optional] 
+**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] 
 **file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional] 
-**list_ids** | **Array<Integer>** | Manadatory if newList is not defined. Ids of the lists in which to add the contacts | [optional] 
+**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] 
 **notify_url** | **String** | URL that will be called once the export process is finished | [optional] 
 **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) |  | [optional] 
+**email_blacklist** | **BOOLEAN** | To blacklist all the contacts for email | [optional] [default to false]
+**sms_blacklist** | **BOOLEAN** | To blacklist all the contacts for sms | [optional] [default to false]
+**update_existing_contacts** | **BOOLEAN** | To facilitate the choice to update the existing contacts | [optional] [default to true]
 
 

docs/RequestContactImportNewList.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **list_name** | **String** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] 
-**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] 
+**folder_id** | **Integer** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional] 
 
 

docs/SMTPApi.md

@@ -482,6 +482,8 @@ Name | Type | Description  | Notes
 
 Send a template
 
+This endpoint is deprecated. Prefer v3/smtp/email instead.
+
 ### Example
 ```ruby
 # load the gem

docs/SendEmail.md

@@ -3,13 +3,14 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email_to** | **Array<String>** | Email addresses of the recipients | 
-**email_bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional] 
-**email_cc** | **Array<String>** | Email addresses of the recipients in cc | [optional] 
-**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
+**email_to** | **Array<String>** | List of the email addresses of the recipients. For example, ['[email protected]', '[email protected]']. | 
+**email_bcc** | **Array<String>** | List of the email addresses of the recipients in bcc | [optional] 
+**email_cc** | **Array<String>** | List of the email addresses of the recipients in cc | [optional] 
+**reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional] 
 **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] 
-**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] 
-**headers** | **Hash<String, String>** |  | [optional] 
-**attributes** | **Hash<String, String>** |  | [optional] 
+**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] 
+**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] 
+**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional] 
+**tags** | **Array<String>** | Tag your emails to find them more easily | [optional] 
 
 

docs/SendEmailAttachment.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 
-**name** | **String** | Required for content. Name of the attachment | [optional] 
+**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | 
+**name** | **String** | Required for content. Name of the attachment | 
 
 

docs/SendSmtpEmail.md

@@ -4,16 +4,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) |  | [optional] 
-**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Email addresses and names of the recipients | 
-**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | Email addresses and names of the recipients in bcc | [optional] 
-**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | Email addresses and names of the recipients in cc | [optional] 
+**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]'}] | 
+**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] 
+**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] 
 **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional] 
 **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] 
 **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] 
 **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) |  | [optional] 
-**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] 
-**headers** | **Hash<String, String>** |  | [optional] 
+**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] 
+**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] 
 **template_id** | **Integer** | Id of the template | [optional] 
-**params** | **Hash<String, String>** |  | [optional] 
+**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional] 
+**tags** | **Array<String>** | Tag your emails to find them more easily | [optional] 
 
 

docs/SendSmtpEmailAttachment.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** | Absolute url of the attachment (no local file). | [optional] 
 **content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 
-**name** | **String** | Required for content. Name of the attachment | [optional] 
+**name** | **String** | Required if content is passed. Name of the attachment | [optional] 
 
 

docs/SendSmtpEmailSender.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Sender Name from which the emails are sent | [optional] 
-**email** | **String** | Sender Email from which the emails are sent | 
+**name** | **String** | Name of the sender from which the emails will be sent | [optional] 
+**email** | **String** | Email of the sender from which the emails will be sent | 
 
 

docs/SendTestEmail.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**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]