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
2 changes: 1 addition & 1 deletion docs/CreateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Name | Type | Description | Notes
**footer** | **str** | Footer of the email campaign | [optional]
**header** | **str** | Header of the email campaign | [optional]
**utm_campaign** | **str** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
**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]
**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]

[[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
2 changes: 1 addition & 1 deletion docs/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the campaign |
**sender** | **str** | Name of the sender. The number of characters is limited to 11 |
**content** | **str** | 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]
**content** | **str** | 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 |
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
**scheduled_at** | **datetime** | 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]

Expand Down
2 changes: 1 addition & 1 deletion docs/CreateSmsCampaignRecipients.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list_ids** | **list[int]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
**exclusion_list_ids** | **list[int]** | List ids which have to be excluded from a campaign |
**exclusion_list_ids** | **list[int]** | List ids which have to be excluded from a campaign | [optional]

[[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
1 change: 1 addition & 0 deletions docs/GetAggregatedReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**spam_reports** | **int** | Number of complaint (spam report) for the timeframe |
**blocked** | **int** | Number of blocked contact emails for the timeframe |
**invalid** | **int** | Number of invalid emails for the timeframe |
**unsubscribed** | **int** | Number of unsubscribed emails for the timeframe |

[[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
1 change: 1 addition & 0 deletions docs/GetReportsReports.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**spam_reports** | **int** | Number of complaints (spam reports) for the date |
**blocked** | **int** | Number of blocked emails for the date |
**invalid** | **int** | Number of invalid emails for the date |
**unsubscribed** | **int** | Number of unsubscribed emails for the date |

[[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
1 change: 0 additions & 1 deletion docs/GetSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Name | Type | Description | Notes
**status** | **str** | Status of the SMS Campaign |
**content** | **str** | Content of the SMS Campaign |
**scheduled_at** | **datetime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**test_sent** | **bool** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
**sender** | **str** | Sender of the SMS Campaign |
**created_at** | **datetime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **datetime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
Expand Down
1 change: 0 additions & 1 deletion docs/GetSmsCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Name | Type | Description | Notes
**status** | **str** | Status of the SMS Campaign |
**content** | **str** | Content of the SMS Campaign |
**scheduled_at** | **datetime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**test_sent** | **bool** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
**sender** | **str** | Sender of the SMS Campaign |
**created_at** | **datetime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **datetime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
Expand Down
8 changes: 6 additions & 2 deletions docs/SMSCampaignsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,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_sms_campaigns**
> GetSmsCampaigns get_sms_campaigns(status=status, limit=limit, offset=offset)
> GetSmsCampaigns get_sms_campaigns(status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset)

Returns the informations for all your created SMS campaigns

Expand All @@ -195,12 +195,14 @@ configuration.api_key['api-key'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = sib_api_v3_sdk.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration))
status = 'status_example' # str | Status of campaign. (optional)
start_date = '2013-10-20T19:20:30+01:00' # datetime | 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' ) (optional)
end_date = '2013-10-20T19:20:30+01:00' # datetime | 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' ) (optional)
limit = 500 # int | Number limitation for the result returned (optional) (default to 500)
offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0)

try:
# Returns the informations for all your created SMS campaigns
api_response = api_instance.get_sms_campaigns(status=status, limit=limit, offset=offset)
api_response = api_instance.get_sms_campaigns(status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling SMSCampaignsApi->get_sms_campaigns: %s\n" % e)
Expand All @@ -211,6 +213,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | **str**| Status of campaign. | [optional]
**start_date** | **datetime**| 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' ) | [optional]
**end_date** | **datetime**| 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' ) | [optional]
**limit** | **int**| Number limitation for the result returned | [optional] [default to 500]
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]

Expand Down
2 changes: 1 addition & 1 deletion docs/SendEmail.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**reply_to** | **str** | Email address which shall be used by campaign recipients to reply back | [optional]
**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]
**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]
**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]
**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.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', 'sender.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** | **list[str]** | Tag your emails to find them more easily | [optional]

Expand Down
4 changes: 2 additions & 2 deletions docs/SendSmtpEmail.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Name | Type | Description | Notes
**subject** | **str** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
**attachment** | [**list[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]
**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.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', 'sender.ip':'1.2.3.4'} | [optional]
**template_id** | **int** | Id of the template | [optional]
**params** | **object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
**params** | **object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional]
**tags** | **list[str]** | Tag your emails to find them more easily | [optional]

[[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
2 changes: 1 addition & 1 deletion docs/SendTransacSms.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
**sender** | **str** | Name of the sender. Only alphanumeric characters. No more than 11 characters |
**recipient** | **str** | Mobile number to send SMS with the country code |
**content** | **str** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
**type** | **str** | Type of the SMS | [optional] [default to 'transactional']
**type** | **str** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
**tag** | **str** | Tag of the message | [optional]
**web_url** | **str** | Webhook to call for each event triggered by the message (delivered etc.) | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/UpdateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Name | Type | Description | Notes
**footer** | **str** | Footer of the email campaign | [optional]
**header** | **str** | Header of the email campaign | [optional]
**utm_campaign** | **str** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]

[[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
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 = "4.1.1"
VERSION = "4.1.2"
# To install the library, run the following
#
# python setup.py install
Expand Down
10 changes: 9 additions & 1 deletion sib_api_v3_sdk/api/sms_campaigns_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,8 @@ def get_sms_campaigns(self, **kwargs): # noqa: E501

:param async bool
:param str status: Status of campaign.
:param datetime start_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' )
:param datetime end_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' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:return: GetSmsCampaigns
Expand All @@ -365,14 +367,16 @@ def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501

:param async bool
:param str status: Status of campaign.
:param datetime start_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' )
:param datetime end_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' )
:param int limit: Number limitation for the result returned
:param int offset: Beginning point in the list to retrieve from.
:return: GetSmsCampaigns
If the method is called asynchronously,
returns the request thread.
"""

all_params = ['status', 'limit', 'offset'] # noqa: E501
all_params = ['status', 'start_date', 'end_date', 'limit', 'offset'] # noqa: E501
all_params.append('async')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
Expand All @@ -397,6 +401,10 @@ def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501
query_params = []
if 'status' in params:
query_params.append(('status', params['status'])) # noqa: E501
if 'start_date' in params:
query_params.append(('startDate', params['start_date'])) # noqa: E501
if 'end_date' in params:
query_params.append(('endDate', params['end_date'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
if 'offset' in params:
Expand Down
4 changes: 2 additions & 2 deletions sib_api_v3_sdk/models/create_email_campaign.py
Original file line number Diff line number Diff line change
Expand Up @@ -592,7 +592,7 @@ def utm_campaign(self, utm_campaign):
def params(self):
"""Gets the params of this CreateEmailCampaign. # noqa: E501

Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic' # noqa: E501
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' # noqa: E501

:return: The params of this CreateEmailCampaign. # noqa: E501
:rtype: object
Expand All @@ -603,7 +603,7 @@ def params(self):
def params(self, params):
"""Sets the params of this CreateEmailCampaign.

Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic' # noqa: E501
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' # noqa: E501

:param params: The params of this CreateEmailCampaign. # noqa: E501
:type: object
Expand Down
5 changes: 3 additions & 2 deletions sib_api_v3_sdk/models/create_sms_campaign.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ def __init__(self, name=None, sender=None, content=None, recipients=None, schedu

self.name = name
self.sender = sender
if content is not None:
self.content = content
self.content = content
if recipients is not None:
self.recipients = recipients
if scheduled_at is not None:
Expand Down Expand Up @@ -139,6 +138,8 @@ def content(self, content):
:param content: The content of this CreateSmsCampaign. # noqa: E501
:type: str
"""
if content is None:
raise ValueError("Invalid value for `content`, must not be `None`") # noqa: E501

self._content = content

Expand Down
Loading