Skip to content

Commit 830ec6f

Browse files
aakanksha-sibaakanksha-sib
authored
Merge pull request #17 from sendinblue/feature_updated_swagger_sync
Swagger updates along with bug fixes and improvements
2 parents 07df6f9 + 600a1df commit 830ec6f

Some content is hidden

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

50 files changed

+364
-334
lines changed

‎.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ref: https://docs.travis-ci.com/user/languages/python
22
language: python
33
python:
4-
- "2.7"
5-
- "3.2"
4+
# - "2.7"
5+
# - "3.2"
66
- "3.3"
77
- "3.4"
88
- "3.5"

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ try:
7272
pprint(api_response)
7373
except ApiException as e:
7474
print("Exception when calling AccountApi->get_account: %s\n" % e)
75+
7576
```
7677

7778
## Documentation for API Endpoints
@@ -244,7 +245,6 @@ Class | Method | HTTP request | Description
244245
- [GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
245246
- [GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
246247
- [GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
247-
- [GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
248248
- [GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
249249
- [GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
250250
- [GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)

‎docs/CreateAttribute.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-
**value** | **str** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
7-
**enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional]
8-
**type** | **str** | 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** | **str** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7+
**enumeration** | [**list[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** | **str** | 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
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎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** | **str** | 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** | **bool** | Blacklist the contact for emails (emailBlacklisted = true) | [optional]
9-
**sms_blacklisted** | **bool** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
6+
**email** | **str** | 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** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
9+
**sms_blacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1010
**list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional]
11-
**update_enabled** | **bool** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to False]
11+
**update_enabled** | **bool** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to False]
1212
**smtp_blacklist_sender** | **list[str]** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

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

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

‎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** | **str** | Target a specific email address | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎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** | **int** | List Id of email campaign (only in case of get email campaign(s)) | [optional]
6+
**list_id** | **int** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional]
77
**unique_clicks** | **int** | Number of unique clicks for the campaign |
8-
**clickers** | **int** | Number of clicks for the campaign |
8+
**clickers** | **int** | Number of total clicks for the campaign |
99
**complaints** | **int** | Number of complaints (Spam reports) for the campaign |
1010
**delivered** | **int** | Number of delivered emails for the campaign |
1111
**sent** | **int** | Number of sent emails for the campaign |
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
1414
**unique_views** | **int** | Number of unique openings for the campaign |
1515
**unsubscriptions** | **int** | Number of unsubscription for the campaign |
1616
**viewed** | **int** | Number of openings for the campaign |
17-
**deferred** | **int** | Number of deferred emails for the campaign |
17+
**deferred** | **int** | Number of deferred emails for the campaign | [optional]
1818

1919
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2020

‎docs/GetContactDetails.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** | **list[int]** | |
1212
**list_unsubscribed** | **list[int]** | | [optional]
13-
**attributes** | **dict(str, str)** | |
13+
**attributes** | **object** | Set of attributes of the contact |
1414

1515
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1616

‎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** | **list[object]** | |
6+
**global_stats** | **object** | Overall statistics of the campaign |
7+
**campaign_stats** | **list[object]** | List-wise statistics of the campaign. |
78
**mirror_click** | **int** | Number of clicks on mirror link |
89
**remaining** | **int** | Number of remaning emails to send |
9-
**links_stats** | [**dict(str, 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
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/GetExtendedCampaignStatsLinksStats.md

Lines changed: 0 additions & 10 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** | **list[int]** | |
1212
**list_unsubscribed** | **list[int]** | | [optional]
13-
**attributes** | **dict(str, str)** | |
13+
**attributes** | **object** | Set of attributes of the contact |
1414
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
1515

1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎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** | **list[str]** | 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** | **list[str]** | 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** | **str** | Webhook that will be called once the export process is finished | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/RequestContactImport.md

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

1215
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1316

‎docs/RequestContactImportNewList.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
**list_name** | **str** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional]
7-
**folder_id** | **int** | 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** | **int** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

‎docs/SMTPApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -477,6 +477,8 @@ Name | Type | Description | Notes
477477
478478
Send a template
479479

480+
This endpoint is deprecated. Prefer v3/smtp/email instead.
481+
480482
### Example
481483
```python
482484
from __future__ import print_function

‎docs/SendEmail.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**email_to** | **list[str]** | Email addresses of the recipients |
7-
**email_bcc** | **list[str]** | Email addresses of the recipients in bcc | [optional]
8-
**email_cc** | **list[str]** | Email addresses of the recipients in cc | [optional]
9-
**reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional]
6+
**email_to** | **list[str]** | List of the email addresses of the recipients. For example, ['[email protected]', '[email protected]']. |
7+
**email_bcc** | **list[str]** | List of the email addresses of the recipients in bcc | [optional]
8+
**email_cc** | **list[str]** | List of the email addresses of the recipients in cc | [optional]
9+
**reply_to** | **str** | Email address which shall be used by campaign recipients to reply back | [optional]
1010
**attachment_url** | **str** | 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** | [**list[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** | **dict(str, str)** | | [optional]
13-
**attributes** | **dict(str, str)** | | [optional]
11+
**attachment** | [**list[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** | **list[str]** | Tag your emails to find them more easily | [optional]
1415

1516
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1617

‎docs/SendEmailAttachment.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-
**content** | **str** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
7-
**name** | **str** | Required for content. Name of the attachment | [optional]
6+
**content** | **str** | Base64 encoded chunk data of the attachment generated on the fly |
7+
**name** | **str** | Required for content. Name of the attachment |
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

0 commit comments

Comments
 (0)