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 .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ docs/_build/
target/

#Ipython Notebook
.ipynb_checkpoints
.ipynb_checkpoints
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,12 @@ Class | Method | HTTP request | Description
- [GetClient](docs/GetClient.md)
- [GetContactCampaignStats](docs/GetContactCampaignStats.md)
- [GetContactCampaignStatsClicked](docs/GetContactCampaignStatsClicked.md)
- [GetContactCampaignStatsLinks](docs/GetContactCampaignStatsLinks.md)
- [GetContactCampaignStatsOpened](docs/GetContactCampaignStatsOpened.md)
- [GetContactCampaignStatsTransacAttributes](docs/GetContactCampaignStatsTransacAttributes.md)
- [GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
- [GetContactCampaignStatsUnsubscriptionsAdminUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md)
- [GetContactCampaignStatsUnsubscriptionsUserUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md)
- [GetContactDetails](docs/GetContactDetails.md)
- [GetContacts](docs/GetContacts.md)
- [GetEmailCampaigns](docs/GetEmailCampaigns.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/GetContactCampaignStatsClicked.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **int** | ID of the campaign which generated the event |
**links** | [**list[GetExtendedContactDetailsStatisticsLinks]**](GetExtendedContactDetailsStatisticsLinks.md) | |
**links** | [**list[GetContactCampaignStatsLinks]**](GetContactCampaignStatsLinks.md) | |

[[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
13 changes: 13 additions & 0 deletions docs/GetContactCampaignStatsLinks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# GetContactCampaignStatsLinks

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | Number of clicks on this link for the campaign |
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has clicked on the link |
**url** | **str** | URL of the clicked link |

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


4 changes: 2 additions & 2 deletions docs/GetContactCampaignStatsUnsubscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_unsubscription** | [**list[GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email |
**admin_unsubscription** | [**list[GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |
**user_unsubscription** | [**list[GetContactCampaignStatsUnsubscriptionsUserUnsubscription]**](GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email |
**admin_unsubscription** | [**list[GetContactCampaignStatsUnsubscriptionsAdminUnsubscription]**](GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |

[[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
11 changes: 11 additions & 0 deletions docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetContactCampaignStatsUnsubscriptionsAdminUnsubscription

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has been unsubscribed |

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


12 changes: 12 additions & 0 deletions docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GetContactCampaignStatsUnsubscriptionsUserUnsubscription

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **int** | ID of the campaign which generated the event |
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has unsubscribed |

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


2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsLinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | Number of clicks on this link for the campaign |
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has clicked on the link |
**ip** | **str** | IP from which the user has clicked on the link | [optional]
**url** | **str** | URL of the clicked link |

[[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/GetExtendedContactDetailsStatisticsOpened.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
**campaign_id** | **int** | ID of the campaign which generated the event |
**count** | **int** | Number of openings for the campaign |
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has opened the email |
**ip** | **str** | IP from which the user has opened the email | [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
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has been unsubscribed |
**ip** | **str** | IP from which the user has been unsubscribed | [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
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **int** | ID of the campaign which generated the event |
**event_time** | **datetime** | UTC date-time of the event |
**ip** | **str** | IP from which the user has unsubscribed |
**ip** | **str** | IP from which the user has unsubscribed | [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/SendSmtpEmail.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [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]
**headers** | **object** | Pass the set of custom headers (not the standard 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, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [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'}. 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]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from setuptools import setup, find_packages # noqa: H301

NAME = "sib-api-v3-sdk"
VERSION = "6.0.2"
VERSION = "6.0.3"
# To install the library, run the following
#
# python setup.py install
Expand Down
3 changes: 3 additions & 0 deletions sib_api_v3_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,12 @@
from sib_api_v3_sdk.models.get_client import GetClient
from sib_api_v3_sdk.models.get_contact_campaign_stats import GetContactCampaignStats
from sib_api_v3_sdk.models.get_contact_campaign_stats_clicked import GetContactCampaignStatsClicked
from sib_api_v3_sdk.models.get_contact_campaign_stats_links import GetContactCampaignStatsLinks
from sib_api_v3_sdk.models.get_contact_campaign_stats_opened import GetContactCampaignStatsOpened
from sib_api_v3_sdk.models.get_contact_campaign_stats_transac_attributes import GetContactCampaignStatsTransacAttributes
from sib_api_v3_sdk.models.get_contact_campaign_stats_unsubscriptions import GetContactCampaignStatsUnsubscriptions
from sib_api_v3_sdk.models.get_contact_campaign_stats_unsubscriptions_admin_unsubscription import GetContactCampaignStatsUnsubscriptionsAdminUnsubscription
from sib_api_v3_sdk.models.get_contact_campaign_stats_unsubscriptions_user_unsubscription import GetContactCampaignStatsUnsubscriptionsUserUnsubscription
from sib_api_v3_sdk.models.get_contact_details import GetContactDetails
from sib_api_v3_sdk.models.get_contacts import GetContacts
from sib_api_v3_sdk.models.get_email_campaigns import GetEmailCampaigns
Expand Down
3 changes: 3 additions & 0 deletions sib_api_v3_sdk/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,12 @@
from sib_api_v3_sdk.models.get_client import GetClient
from sib_api_v3_sdk.models.get_contact_campaign_stats import GetContactCampaignStats
from sib_api_v3_sdk.models.get_contact_campaign_stats_clicked import GetContactCampaignStatsClicked
from sib_api_v3_sdk.models.get_contact_campaign_stats_links import GetContactCampaignStatsLinks
from sib_api_v3_sdk.models.get_contact_campaign_stats_opened import GetContactCampaignStatsOpened
from sib_api_v3_sdk.models.get_contact_campaign_stats_transac_attributes import GetContactCampaignStatsTransacAttributes
from sib_api_v3_sdk.models.get_contact_campaign_stats_unsubscriptions import GetContactCampaignStatsUnsubscriptions
from sib_api_v3_sdk.models.get_contact_campaign_stats_unsubscriptions_admin_unsubscription import GetContactCampaignStatsUnsubscriptionsAdminUnsubscription
from sib_api_v3_sdk.models.get_contact_campaign_stats_unsubscriptions_user_unsubscription import GetContactCampaignStatsUnsubscriptionsUserUnsubscription
from sib_api_v3_sdk.models.get_contact_details import GetContactDetails
from sib_api_v3_sdk.models.get_contacts import GetContacts
from sib_api_v3_sdk.models.get_email_campaigns import GetEmailCampaigns
Expand Down
8 changes: 4 additions & 4 deletions sib_api_v3_sdk/models/get_contact_campaign_stats_clicked.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

import six

from sib_api_v3_sdk.models.get_extended_contact_details_statistics_links import GetExtendedContactDetailsStatisticsLinks # noqa: F401,E501
from sib_api_v3_sdk.models.get_contact_campaign_stats_links import GetContactCampaignStatsLinks # noqa: F401,E501


class GetContactCampaignStatsClicked(object):
Expand All @@ -34,7 +34,7 @@ class GetContactCampaignStatsClicked(object):
"""
swagger_types = {
'campaign_id': 'int',
'links': 'list[GetExtendedContactDetailsStatisticsLinks]'
'links': 'list[GetContactCampaignStatsLinks]'
}

attribute_map = {
Expand Down Expand Up @@ -83,7 +83,7 @@ def links(self):


:return: The links of this GetContactCampaignStatsClicked. # noqa: E501
:rtype: list[GetExtendedContactDetailsStatisticsLinks]
:rtype: list[GetContactCampaignStatsLinks]
"""
return self._links

Expand All @@ -93,7 +93,7 @@ def links(self, links):


:param links: The links of this GetContactCampaignStatsClicked. # noqa: E501
:type: list[GetExtendedContactDetailsStatisticsLinks]
:type: list[GetContactCampaignStatsLinks]
"""
if links is None:
raise ValueError("Invalid value for `links`, must not be `None`") # noqa: E501
Expand Down
202 changes: 202 additions & 0 deletions sib_api_v3_sdk/models/get_contact_campaign_stats_links.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
# coding: utf-8

"""
SendinBlue API

SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | # noqa: E501

OpenAPI spec version: 3.0.0
Contact: contact@sendinblue.com
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""


import pprint
import re # noqa: F401

import six


class GetContactCampaignStatsLinks(object):
"""NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.
"""

"""
Attributes:
swagger_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
swagger_types = {
'count': 'int',
'event_time': 'datetime',
'ip': 'str',
'url': 'str'
}

attribute_map = {
'count': 'count',
'event_time': 'eventTime',
'ip': 'ip',
'url': 'url'
}

def __init__(self, count=None, event_time=None, ip=None, url=None): # noqa: E501
"""GetContactCampaignStatsLinks - a model defined in Swagger""" # noqa: E501

self._count = None
self._event_time = None
self._ip = None
self._url = None
self.discriminator = None

self.count = count
self.event_time = event_time
self.ip = ip
self.url = url

@property
def count(self):
"""Gets the count of this GetContactCampaignStatsLinks. # noqa: E501

Number of clicks on this link for the campaign # noqa: E501

:return: The count of this GetContactCampaignStatsLinks. # noqa: E501
:rtype: int
"""
return self._count

@count.setter
def count(self, count):
"""Sets the count of this GetContactCampaignStatsLinks.

Number of clicks on this link for the campaign # noqa: E501

:param count: The count of this GetContactCampaignStatsLinks. # noqa: E501
:type: int
"""
if count is None:
raise ValueError("Invalid value for `count`, must not be `None`") # noqa: E501

self._count = count

@property
def event_time(self):
"""Gets the event_time of this GetContactCampaignStatsLinks. # noqa: E501

UTC date-time of the event # noqa: E501

:return: The event_time of this GetContactCampaignStatsLinks. # noqa: E501
:rtype: datetime
"""
return self._event_time

@event_time.setter
def event_time(self, event_time):
"""Sets the event_time of this GetContactCampaignStatsLinks.

UTC date-time of the event # noqa: E501

:param event_time: The event_time of this GetContactCampaignStatsLinks. # noqa: E501
:type: datetime
"""
if event_time is None:
raise ValueError("Invalid value for `event_time`, must not be `None`") # noqa: E501

self._event_time = event_time

@property
def ip(self):
"""Gets the ip of this GetContactCampaignStatsLinks. # noqa: E501

IP from which the user has clicked on the link # noqa: E501

:return: The ip of this GetContactCampaignStatsLinks. # noqa: E501
:rtype: str
"""
return self._ip

@ip.setter
def ip(self, ip):
"""Sets the ip of this GetContactCampaignStatsLinks.

IP from which the user has clicked on the link # noqa: E501

:param ip: The ip of this GetContactCampaignStatsLinks. # noqa: E501
:type: str
"""
if ip is None:
raise ValueError("Invalid value for `ip`, must not be `None`") # noqa: E501

self._ip = ip

@property
def url(self):
"""Gets the url of this GetContactCampaignStatsLinks. # noqa: E501

URL of the clicked link # noqa: E501

:return: The url of this GetContactCampaignStatsLinks. # noqa: E501
:rtype: str
"""
return self._url

@url.setter
def url(self, url):
"""Sets the url of this GetContactCampaignStatsLinks.

URL of the clicked link # noqa: E501

:param url: The url of this GetContactCampaignStatsLinks. # noqa: E501
:type: str
"""
if url is None:
raise ValueError("Invalid value for `url`, must not be `None`") # noqa: E501

self._url = url

def to_dict(self):
"""Returns the model properties as a dict"""
result = {}

for attr, _ in six.iteritems(self.swagger_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value

return result

def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())

def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()

def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, GetContactCampaignStatsLinks):
return False

return self.__dict__ == other.__dict__

def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
Loading