diff --git a/docs/CreateEmailCampaign.md b/docs/CreateEmailCampaign.md index 37acb14..8353a92 100644 --- a/docs/CreateEmailCampaign.md +++ b/docs/CreateEmailCampaign.md @@ -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) diff --git a/docs/CreateSmsCampaign.md b/docs/CreateSmsCampaign.md index fe1088d..9c0ca89 100644 --- a/docs/CreateSmsCampaign.md +++ b/docs/CreateSmsCampaign.md @@ -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] diff --git a/docs/CreateSmsCampaignRecipients.md b/docs/CreateSmsCampaignRecipients.md index 388b1b4..5fdbde1 100644 --- a/docs/CreateSmsCampaignRecipients.md +++ b/docs/CreateSmsCampaignRecipients.md @@ -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) diff --git a/docs/GetAggregatedReport.md b/docs/GetAggregatedReport.md index 62169ca..f3ae963 100644 --- a/docs/GetAggregatedReport.md +++ b/docs/GetAggregatedReport.md @@ -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) diff --git a/docs/GetReportsReports.md b/docs/GetReportsReports.md index b7e4883..640cb8e 100644 --- a/docs/GetReportsReports.md +++ b/docs/GetReportsReports.md @@ -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) diff --git a/docs/GetSmsCampaign.md b/docs/GetSmsCampaign.md index c259346..382b5f6 100644 --- a/docs/GetSmsCampaign.md +++ b/docs/GetSmsCampaign.md @@ -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) | diff --git a/docs/GetSmsCampaignOverview.md b/docs/GetSmsCampaignOverview.md index 565025a..b8272f7 100644 --- a/docs/GetSmsCampaignOverview.md +++ b/docs/GetSmsCampaignOverview.md @@ -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) | diff --git a/docs/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md index 2cfa673..0a59726 100644 --- a/docs/SMSCampaignsApi.md +++ b/docs/SMSCampaignsApi.md @@ -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 @@ -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) @@ -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] diff --git a/docs/SendEmail.md b/docs/SendEmail.md index cf0e350..8ddaade 100644 --- a/docs/SendEmail.md +++ b/docs/SendEmail.md @@ -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] diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md index 7df86a4..2c0a677 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -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) diff --git a/docs/SendTransacSms.md b/docs/SendTransacSms.md index b2ce48f..b1cd2e0 100644 --- a/docs/SendTransacSms.md +++ b/docs/SendTransacSms.md @@ -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] diff --git a/docs/UpdateEmailCampaign.md b/docs/UpdateEmailCampaign.md index acdbb8a..a286706 100644 --- a/docs/UpdateEmailCampaign.md +++ b/docs/UpdateEmailCampaign.md @@ -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) diff --git a/setup.py b/setup.py index 7583e7f..dbc34de 100644 --- a/setup.py +++ b/setup.py @@ -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 diff --git a/sib_api_v3_sdk/api/sms_campaigns_api.py b/sib_api_v3_sdk/api/sms_campaigns_api.py index 36900cb..6131f7b 100644 --- a/sib_api_v3_sdk/api/sms_campaigns_api.py +++ b/sib_api_v3_sdk/api/sms_campaigns_api.py @@ -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 @@ -365,6 +367,8 @@ 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 @@ -372,7 +376,7 @@ def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501 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') @@ -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: diff --git a/sib_api_v3_sdk/models/create_email_campaign.py b/sib_api_v3_sdk/models/create_email_campaign.py index a13b91b..cd0c6fc 100644 --- a/sib_api_v3_sdk/models/create_email_campaign.py +++ b/sib_api_v3_sdk/models/create_email_campaign.py @@ -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 @@ -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 diff --git a/sib_api_v3_sdk/models/create_sms_campaign.py b/sib_api_v3_sdk/models/create_sms_campaign.py index 3e378e6..9ac45c1 100644 --- a/sib_api_v3_sdk/models/create_sms_campaign.py +++ b/sib_api_v3_sdk/models/create_sms_campaign.py @@ -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: @@ -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 diff --git a/sib_api_v3_sdk/models/create_sms_campaign_recipients.py b/sib_api_v3_sdk/models/create_sms_campaign_recipients.py index 8458286..2d49107 100644 --- a/sib_api_v3_sdk/models/create_sms_campaign_recipients.py +++ b/sib_api_v3_sdk/models/create_sms_campaign_recipients.py @@ -48,7 +48,8 @@ def __init__(self, list_ids=None, exclusion_list_ids=None): # noqa: E501 self.discriminator = None self.list_ids = list_ids - self.exclusion_list_ids = exclusion_list_ids + if exclusion_list_ids is not None: + self.exclusion_list_ids = exclusion_list_ids @property def list_ids(self): @@ -95,8 +96,6 @@ def exclusion_list_ids(self, exclusion_list_ids): :param exclusion_list_ids: The exclusion_list_ids of this CreateSmsCampaignRecipients. # noqa: E501 :type: list[int] """ - if exclusion_list_ids is None: - raise ValueError("Invalid value for `exclusion_list_ids`, must not be `None`") # noqa: E501 self._exclusion_list_ids = exclusion_list_ids diff --git a/sib_api_v3_sdk/models/get_aggregated_report.py b/sib_api_v3_sdk/models/get_aggregated_report.py index 24006a6..b038823 100644 --- a/sib_api_v3_sdk/models/get_aggregated_report.py +++ b/sib_api_v3_sdk/models/get_aggregated_report.py @@ -42,7 +42,8 @@ class GetAggregatedReport(object): 'unique_opens': 'int', 'spam_reports': 'int', 'blocked': 'int', - 'invalid': 'int' + 'invalid': 'int', + 'unsubscribed': 'int' } attribute_map = { @@ -57,10 +58,11 @@ class GetAggregatedReport(object): 'unique_opens': 'uniqueOpens', 'spam_reports': 'spamReports', 'blocked': 'blocked', - 'invalid': 'invalid' + 'invalid': 'invalid', + 'unsubscribed': 'unsubscribed' } - def __init__(self, range=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None): # noqa: E501 + def __init__(self, range=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None, unsubscribed=None): # noqa: E501 """GetAggregatedReport - a model defined in Swagger""" # noqa: E501 self._range = None @@ -75,6 +77,7 @@ def __init__(self, range=None, requests=None, delivered=None, hard_bounces=None, self._spam_reports = None self._blocked = None self._invalid = None + self._unsubscribed = None self.discriminator = None self.range = range @@ -89,6 +92,7 @@ def __init__(self, range=None, requests=None, delivered=None, hard_bounces=None, self.spam_reports = spam_reports self.blocked = blocked self.invalid = invalid + self.unsubscribed = unsubscribed @property def range(self): @@ -390,6 +394,31 @@ def invalid(self, invalid): self._invalid = invalid + @property + def unsubscribed(self): + """Gets the unsubscribed of this GetAggregatedReport. # noqa: E501 + + Number of unsubscribed emails for the timeframe # noqa: E501 + + :return: The unsubscribed of this GetAggregatedReport. # noqa: E501 + :rtype: int + """ + return self._unsubscribed + + @unsubscribed.setter + def unsubscribed(self, unsubscribed): + """Sets the unsubscribed of this GetAggregatedReport. + + Number of unsubscribed emails for the timeframe # noqa: E501 + + :param unsubscribed: The unsubscribed of this GetAggregatedReport. # noqa: E501 + :type: int + """ + if unsubscribed is None: + raise ValueError("Invalid value for `unsubscribed`, must not be `None`") # noqa: E501 + + self._unsubscribed = unsubscribed + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/get_email_event_report_events.py b/sib_api_v3_sdk/models/get_email_event_report_events.py index 6825528..4db499c 100644 --- a/sib_api_v3_sdk/models/get_email_event_report_events.py +++ b/sib_api_v3_sdk/models/get_email_event_report_events.py @@ -208,7 +208,7 @@ def event(self, event): """ if event is None: raise ValueError("Invalid value for `event`, must not be `None`") # noqa: E501 - allowed_values = ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked"] # noqa: E501 + allowed_values = ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed"] # noqa: E501 if event not in allowed_values: raise ValueError( "Invalid value for `event` ({0}), must be one of {1}" # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_reports_reports.py b/sib_api_v3_sdk/models/get_reports_reports.py index 1af9341..ebcabbf 100644 --- a/sib_api_v3_sdk/models/get_reports_reports.py +++ b/sib_api_v3_sdk/models/get_reports_reports.py @@ -42,7 +42,8 @@ class GetReportsReports(object): 'unique_opens': 'int', 'spam_reports': 'int', 'blocked': 'int', - 'invalid': 'int' + 'invalid': 'int', + 'unsubscribed': 'int' } attribute_map = { @@ -57,10 +58,11 @@ class GetReportsReports(object): 'unique_opens': 'uniqueOpens', 'spam_reports': 'spamReports', 'blocked': 'blocked', - 'invalid': 'invalid' + 'invalid': 'invalid', + 'unsubscribed': 'unsubscribed' } - def __init__(self, date=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None): # noqa: E501 + def __init__(self, date=None, requests=None, delivered=None, hard_bounces=None, soft_bounces=None, clicks=None, unique_clicks=None, opens=None, unique_opens=None, spam_reports=None, blocked=None, invalid=None, unsubscribed=None): # noqa: E501 """GetReportsReports - a model defined in Swagger""" # noqa: E501 self._date = None @@ -75,6 +77,7 @@ def __init__(self, date=None, requests=None, delivered=None, hard_bounces=None, self._spam_reports = None self._blocked = None self._invalid = None + self._unsubscribed = None self.discriminator = None self.date = date @@ -89,6 +92,7 @@ def __init__(self, date=None, requests=None, delivered=None, hard_bounces=None, self.spam_reports = spam_reports self.blocked = blocked self.invalid = invalid + self.unsubscribed = unsubscribed @property def date(self): @@ -390,6 +394,31 @@ def invalid(self, invalid): self._invalid = invalid + @property + def unsubscribed(self): + """Gets the unsubscribed of this GetReportsReports. # noqa: E501 + + Number of unsubscribed emails for the date # noqa: E501 + + :return: The unsubscribed of this GetReportsReports. # noqa: E501 + :rtype: int + """ + return self._unsubscribed + + @unsubscribed.setter + def unsubscribed(self, unsubscribed): + """Sets the unsubscribed of this GetReportsReports. + + Number of unsubscribed emails for the date # noqa: E501 + + :param unsubscribed: The unsubscribed of this GetReportsReports. # noqa: E501 + :type: int + """ + if unsubscribed is None: + raise ValueError("Invalid value for `unsubscribed`, must not be `None`") # noqa: E501 + + self._unsubscribed = unsubscribed + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/get_sms_campaign.py b/sib_api_v3_sdk/models/get_sms_campaign.py index 8b3aceb..890e317 100644 --- a/sib_api_v3_sdk/models/get_sms_campaign.py +++ b/sib_api_v3_sdk/models/get_sms_campaign.py @@ -38,7 +38,6 @@ class GetSmsCampaign(object): 'status': 'str', 'content': 'str', 'scheduled_at': 'datetime', - 'test_sent': 'bool', 'sender': 'str', 'created_at': 'datetime', 'modified_at': 'datetime', @@ -52,7 +51,6 @@ class GetSmsCampaign(object): 'status': 'status', 'content': 'content', 'scheduled_at': 'scheduledAt', - 'test_sent': 'testSent', 'sender': 'sender', 'created_at': 'createdAt', 'modified_at': 'modifiedAt', @@ -60,7 +58,7 @@ class GetSmsCampaign(object): 'statistics': 'statistics' } - def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=None, test_sent=None, sender=None, created_at=None, modified_at=None, recipients=None, statistics=None): # noqa: E501 + def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=None, sender=None, created_at=None, modified_at=None, recipients=None, statistics=None): # noqa: E501 """GetSmsCampaign - a model defined in Swagger""" # noqa: E501 self._id = None @@ -68,7 +66,6 @@ def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=N self._status = None self._content = None self._scheduled_at = None - self._test_sent = None self._sender = None self._created_at = None self._modified_at = None @@ -81,7 +78,6 @@ def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=N self.status = status self.content = content self.scheduled_at = scheduled_at - self.test_sent = test_sent self.sender = sender self.created_at = created_at self.modified_at = modified_at @@ -160,7 +156,7 @@ def status(self, status): """ if status is None: raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 - allowed_values = ["draft", "sent", "archive", "queued", "suspended", "in_process"] # noqa: E501 + allowed_values = ["draft", "sent", "archive", "queued", "suspended", "inProcess"] # noqa: E501 if status not in allowed_values: raise ValueError( "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 @@ -219,31 +215,6 @@ def scheduled_at(self, scheduled_at): self._scheduled_at = scheduled_at - @property - def test_sent(self): - """Gets the test_sent of this GetSmsCampaign. # noqa: E501 - - Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) # noqa: E501 - - :return: The test_sent of this GetSmsCampaign. # noqa: E501 - :rtype: bool - """ - return self._test_sent - - @test_sent.setter - def test_sent(self, test_sent): - """Sets the test_sent of this GetSmsCampaign. - - Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) # noqa: E501 - - :param test_sent: The test_sent of this GetSmsCampaign. # noqa: E501 - :type: bool - """ - if test_sent is None: - raise ValueError("Invalid value for `test_sent`, must not be `None`") # noqa: E501 - - self._test_sent = test_sent - @property def sender(self): """Gets the sender of this GetSmsCampaign. # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_sms_campaign_overview.py b/sib_api_v3_sdk/models/get_sms_campaign_overview.py index 7784dd4..7a49976 100644 --- a/sib_api_v3_sdk/models/get_sms_campaign_overview.py +++ b/sib_api_v3_sdk/models/get_sms_campaign_overview.py @@ -36,7 +36,6 @@ class GetSmsCampaignOverview(object): 'status': 'str', 'content': 'str', 'scheduled_at': 'datetime', - 'test_sent': 'bool', 'sender': 'str', 'created_at': 'datetime', 'modified_at': 'datetime' @@ -48,13 +47,12 @@ class GetSmsCampaignOverview(object): 'status': 'status', 'content': 'content', 'scheduled_at': 'scheduledAt', - 'test_sent': 'testSent', 'sender': 'sender', 'created_at': 'createdAt', 'modified_at': 'modifiedAt' } - def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=None, test_sent=None, sender=None, created_at=None, modified_at=None): # noqa: E501 + def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=None, sender=None, created_at=None, modified_at=None): # noqa: E501 """GetSmsCampaignOverview - a model defined in Swagger""" # noqa: E501 self._id = None @@ -62,7 +60,6 @@ def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=N self._status = None self._content = None self._scheduled_at = None - self._test_sent = None self._sender = None self._created_at = None self._modified_at = None @@ -73,7 +70,6 @@ def __init__(self, id=None, name=None, status=None, content=None, scheduled_at=N self.status = status self.content = content self.scheduled_at = scheduled_at - self.test_sent = test_sent self.sender = sender self.created_at = created_at self.modified_at = modified_at @@ -150,7 +146,7 @@ def status(self, status): """ if status is None: raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 - allowed_values = ["draft", "sent", "archive", "queued", "suspended", "in_process"] # noqa: E501 + allowed_values = ["draft", "sent", "archive", "queued", "suspended", "inProcess"] # noqa: E501 if status not in allowed_values: raise ValueError( "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 @@ -209,31 +205,6 @@ def scheduled_at(self, scheduled_at): self._scheduled_at = scheduled_at - @property - def test_sent(self): - """Gets the test_sent of this GetSmsCampaignOverview. # noqa: E501 - - Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) # noqa: E501 - - :return: The test_sent of this GetSmsCampaignOverview. # noqa: E501 - :rtype: bool - """ - return self._test_sent - - @test_sent.setter - def test_sent(self, test_sent): - """Sets the test_sent of this GetSmsCampaignOverview. - - Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) # noqa: E501 - - :param test_sent: The test_sent of this GetSmsCampaignOverview. # noqa: E501 - :type: bool - """ - if test_sent is None: - raise ValueError("Invalid value for `test_sent`, must not be `None`") # noqa: E501 - - self._test_sent = test_sent - @property def sender(self): """Gets the sender of this GetSmsCampaignOverview. # noqa: E501 diff --git a/sib_api_v3_sdk/models/send_email.py b/sib_api_v3_sdk/models/send_email.py index 3589ca8..5f21467 100644 --- a/sib_api_v3_sdk/models/send_email.py +++ b/sib_api_v3_sdk/models/send_email.py @@ -232,7 +232,7 @@ def attachment(self, attachment): def headers(self): """Gets the headers of this SendEmail. # noqa: E501 - 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'} # noqa: E501 + 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'} # noqa: E501 :return: The headers of this SendEmail. # noqa: E501 :rtype: object @@ -243,7 +243,7 @@ def headers(self): def headers(self, headers): """Sets the headers of this SendEmail. - 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'} # noqa: E501 + 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'} # noqa: E501 :param headers: The headers of this SendEmail. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py index e10c5b5..f5005c8 100644 --- a/sib_api_v3_sdk/models/send_smtp_email.py +++ b/sib_api_v3_sdk/models/send_smtp_email.py @@ -322,7 +322,7 @@ def attachment(self, attachment): def headers(self): """Gets the headers of this SendSmtpEmail. # noqa: E501 - 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'} # noqa: E501 + 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'} # noqa: E501 :return: The headers of this SendSmtpEmail. # noqa: E501 :rtype: object @@ -333,7 +333,7 @@ def headers(self): def headers(self, headers): """Sets the headers of this SendSmtpEmail. - 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'} # noqa: E501 + 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'} # noqa: E501 :param headers: The headers of this SendSmtpEmail. # noqa: E501 :type: object @@ -368,7 +368,7 @@ def template_id(self, template_id): def params(self): """Gets the params of this SendSmtpEmail. # noqa: E501 - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. # noqa: E501 + 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. # noqa: E501 :return: The params of this SendSmtpEmail. # noqa: E501 :rtype: object @@ -379,7 +379,7 @@ def params(self): def params(self, params): """Sets the params of this SendSmtpEmail. - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. # noqa: E501 + 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. # noqa: E501 :param params: The params of this SendSmtpEmail. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/send_transac_sms.py b/sib_api_v3_sdk/models/send_transac_sms.py index ce6cf58..5eada97 100644 --- a/sib_api_v3_sdk/models/send_transac_sms.py +++ b/sib_api_v3_sdk/models/send_transac_sms.py @@ -150,7 +150,7 @@ def content(self, content): def type(self): """Gets the type of this SendTransacSms. # noqa: E501 - Type of the SMS # noqa: E501 + 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. # noqa: E501 :return: The type of this SendTransacSms. # noqa: E501 :rtype: str @@ -161,7 +161,7 @@ def type(self): def type(self, type): """Sets the type of this SendTransacSms. - Type of the SMS # noqa: E501 + 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. # noqa: E501 :param type: The type of this SendTransacSms. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/update_email_campaign.py b/sib_api_v3_sdk/models/update_email_campaign.py index 9828645..51ffc02 100644 --- a/sib_api_v3_sdk/models/update_email_campaign.py +++ b/sib_api_v3_sdk/models/update_email_campaign.py @@ -526,7 +526,7 @@ def utm_campaign(self, utm_campaign): def params(self): """Gets the params of this UpdateEmailCampaign. # noqa: E501 - Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. # noqa: E501 + 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' # noqa: E501 :return: The params of this UpdateEmailCampaign. # noqa: E501 :rtype: object @@ -537,7 +537,7 @@ def params(self): def params(self, params): """Sets the params of this UpdateEmailCampaign. - Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. # noqa: E501 + 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' # noqa: E501 :param params: The params of this UpdateEmailCampaign. # noqa: E501 :type: object