Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,18 +143,19 @@ Class | Method | HTTP request | Description
*ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
*ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
*SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates a SMS campaign
*SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
*SMSCampaignsApi* | [**delete_sms_campaigns**](docs/SMSCampaignsApi.md#delete_sms_campaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
*SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get a SMS campaign
*SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
*SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
*SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
*SMSCampaignsApi* | [**send_sms_campaign_now**](docs/SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
*SMSCampaignsApi* | [**send_sms_report**](docs/SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
*SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
*SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates a SMS campaign
*SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
*SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
*SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an smtp template
*SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
*SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
*SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
*SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
*SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
Expand Down
6 changes: 4 additions & 2 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_contacts**
> GetContacts get_contacts(limit=limit, offset=offset)
> GetContacts get_contacts(limit=limit, offset=offset, modified_since=modified_since)

Get all the contacts

Expand All @@ -608,10 +608,11 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.ContactsApi()
limit = 50 # int | Number of documents per page (optional) (default to 50)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional)

try:
# Get all the contacts
api_response = api_instance.get_contacts(limit=limit, offset=offset)
api_response = api_instance.get_contacts(limit=limit, offset=offset, modified_since=modified_since)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactsApi->get_contacts: %s\n" % e)
Expand All @@ -623,6 +624,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number of documents per page | [optional] [default to 50]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/CreateContact.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**email_blacklisted** | **bool** | Blacklist the contact for emails (emailBlacklisted = true) | [optional]
**sms_blacklisted** | **bool** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
**list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional]
**update_enabled** | **bool** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to False]

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

Expand Down
5 changes: 3 additions & 2 deletions docs/GetEmailEventReportEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | Email address which generates the event |
**date** | **date** | Date on which the event has been generated |
**date** | **datetime** | Date on which the event has been generated |
**subject** | **str** | Subject of the event | [optional]
**message_id** | **str** | Message ID which generated the event |
**event** | **str** | Event which occurred |
**reason** | **str** | Reason of bounce (only available if the event is hardbounce or softbounce) |
**reason** | **str** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
**tag** | **str** | Tag of the email which generated the event |
**ip** | **str** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
**link** | **str** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
**_from** | **str** | Sender email from which the emails are sent |

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

Expand Down
18 changes: 9 additions & 9 deletions docs/SMSCampaignsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ All URIs are relative to *https://api.sendinblue.com/v3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates a SMS campaign
[**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
[**delete_sms_campaigns**](SMSCampaignsApi.md#delete_sms_campaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
[**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get a SMS campaign
[**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
[**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
[**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
[**send_sms_campaign_now**](SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
[**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
[**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
[**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates a SMS campaign
[**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
[**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status


# **create_sms_campaign**
> CreateModel create_sms_campaign(create_sms_campaign)

Creates a SMS campaign
Creates an SMS campaign

### Example
```python
Expand All @@ -39,7 +39,7 @@ api_instance = sib_api_v3_sdk.SMSCampaignsApi()
create_sms_campaign = sib_api_v3_sdk.CreateSmsCampaign() # CreateSmsCampaign | Values to create an SMS Campaign

try:
# Creates a SMS campaign
# Creates an SMS campaign
api_response = api_instance.create_sms_campaign(create_sms_campaign)
pprint(api_response)
except ApiException as e:
Expand Down Expand Up @@ -120,7 +120,7 @@ void (empty response body)
# **get_sms_campaign**
> GetSmsCampaign get_sms_campaign(campaign_id, get_sms_campaign)

Get a SMS campaign
Get an SMS campaign

### Example
```python
Expand All @@ -141,7 +141,7 @@ campaign_id = 789 # int | id of the SMS campaign
get_sms_campaign = sib_api_v3_sdk.GetSmsCampaign() # GetSmsCampaign | Values to update an SMS Campaign

try:
# Get a SMS campaign
# Get an SMS campaign
api_response = api_instance.get_sms_campaign(campaign_id, get_sms_campaign)
pprint(api_response)
except ApiException as e:
Expand Down Expand Up @@ -439,7 +439,7 @@ void (empty response body)
# **update_sms_campaign**
> update_sms_campaign(campaign_id, update_sms_campaign)

Updates a SMS campaign
Updates an SMS campaign

### Example
```python
Expand All @@ -460,7 +460,7 @@ campaign_id = 789 # int | id of the SMS campaign
update_sms_campaign = sib_api_v3_sdk.UpdateSmsCampaign() # UpdateSmsCampaign | Values to update an SMS Campaign

try:
# Updates a SMS campaign
# Updates an SMS campaign
api_instance.update_sms_campaign(campaign_id, update_sms_campaign)
except ApiException as e:
print("Exception when calling SMSCampaignsApi->update_sms_campaign: %s\n" % e)
Expand Down
51 changes: 51 additions & 0 deletions docs/SMTPApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an smtp template
[**delete_hardbounces**](SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
[**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
[**get_aggregated_smtp_report**](SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
[**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
[**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
Expand Down Expand Up @@ -120,6 +121,56 @@ void (empty response body)

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

# **delete_smtp_template**
> delete_smtp_template(template_id)

Delete an inactive smtp template

### Example
```python
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# sib_api_v3_sdk.configuration.api_key_prefix['api-key'] = 'Bearer'

# create an instance of the API class
api_instance = sib_api_v3_sdk.SMTPApi()
template_id = 789 # int | id of the template

try:
# Delete an inactive smtp template
api_instance.delete_smtp_template(template_id)
except ApiException as e:
print("Exception when calling SMTPApi->delete_smtp_template: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**template_id** | **int**| id of the template |

### Return type

void (empty response body)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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

# **get_aggregated_smtp_report**
> GetAggregatedReport get_aggregated_smtp_report(start_date=start_date, end_date=end_date, days=days, tag=tag)

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from setuptools import setup, find_packages

NAME = "sib-api-v3-sdk"
VERSION = "1.1.1"
VERSION = "1.1.2"
# To install the library, run the following
#
# python setup.py install
Expand Down
6 changes: 5 additions & 1 deletion sib_api_v3_sdk/apis/contacts_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1198,6 +1198,7 @@ def get_contacts(self, **kwargs):
for asynchronous request. (optional)
:param int limit: Number of documents per page
:param int offset: Index of the first document of the page
:param datetime modified_since: Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
:return: GetContacts
If the method is called asynchronously,
returns the request thread.
Expand All @@ -1224,12 +1225,13 @@ def get_contacts_with_http_info(self, **kwargs):
for asynchronous request. (optional)
:param int limit: Number of documents per page
:param int offset: Index of the first document of the page
:param datetime modified_since: Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
:return: GetContacts
If the method is called asynchronously,
returns the request thread.
"""

all_params = ['limit', 'offset']
all_params = ['limit', 'offset', 'modified_since']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
Expand Down Expand Up @@ -1257,6 +1259,8 @@ def get_contacts_with_http_info(self, **kwargs):
query_params.append(('limit', params['limit']))
if 'offset' in params:
query_params.append(('offset', params['offset']))
if 'modified_since' in params:
query_params.append(('modifiedSince', params['modified_since']))

header_params = {}

Expand Down
12 changes: 6 additions & 6 deletions sib_api_v3_sdk/apis/sms_campaigns_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def __init__(self, api_client=None):

def create_sms_campaign(self, create_sms_campaign, **kwargs):
"""
Creates a SMS campaign
Creates an SMS campaign
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -67,7 +67,7 @@ def create_sms_campaign(self, create_sms_campaign, **kwargs):

def create_sms_campaign_with_http_info(self, create_sms_campaign, **kwargs):
"""
Creates a SMS campaign
Creates an SMS campaign
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -250,7 +250,7 @@ def delete_sms_campaigns_with_http_info(self, campaign_id, **kwargs):

def get_sms_campaign(self, campaign_id, get_sms_campaign, **kwargs):
"""
Get a SMS campaign
Get an SMS campaign
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -276,7 +276,7 @@ def get_sms_campaign(self, campaign_id, get_sms_campaign, **kwargs):

def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwargs):
"""
Get a SMS campaign
Get an SMS campaign
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -910,7 +910,7 @@ def send_test_sms_with_http_info(self, campaign_id, send_test_sms, **kwargs):

def update_sms_campaign(self, campaign_id, update_sms_campaign, **kwargs):
"""
Updates a SMS campaign
Updates an SMS campaign
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -936,7 +936,7 @@ def update_sms_campaign(self, campaign_id, update_sms_campaign, **kwargs):

def update_sms_campaign_with_http_info(self, campaign_id, update_sms_campaign, **kwargs):
"""
Updates a SMS campaign
Updates an SMS campaign
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down
Loading