Merge pull request #21 from sendinblue/feature_updated_swagger_sync

Swagger update for email campaign filters

Author: aakanksha-sib

docs/CreateAttribute.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **str** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
 **enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional] 
-**type** | **str** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] 
+**type** | **str** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [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)
 

docs/EmailCampaignsApi.md

@@ -226,7 +226,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_email_campaigns**
-> GetEmailCampaigns get_email_campaigns(type=type, status=status, limit=limit, offset=offset)
+> GetEmailCampaigns get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset)
 
 Return all your created campaigns
 
@@ -248,12 +248,14 @@ configuration.api_key['api-key'] = 'YOUR_API_KEY'
 api_instance = sib_api_v3_sdk.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration))
 type = 'type_example' # str | Filter on the type of the campaigns (optional)
 status = 'status_example' # str | Filter on the status of the 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 email 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 email 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 of documents per page (optional) (default to 500)
 offset = 0 # int | Index of the first document in the page (optional) (default to 0)
 
 try:
     # Return all your created campaigns
-    api_response = api_instance.get_email_campaigns(type=type, status=status, limit=limit, offset=offset)
+    api_response = api_instance.get_email_campaigns(type=type, 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 EmailCampaignsApi->get_email_campaigns: %s\n" % e)
@@ -265,6 +267,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **type** | **str**| Filter on the type of the campaigns | [optional] 
  **status** | **str**| Filter on the status of the 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 email 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 email 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 of documents per page | [optional] [default to 500]
  **offset** | **int**| Index of the first document in the page | [optional] [default to 0]
 

docs/GetEmailCampaign.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **inline_image_activation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] 
 **mirror_active** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
+**sent_date** | **datetime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] 
 **recipients** | **object** |  | 
 **statistics** | **object** |  | 
 

docs/GetExtendedCampaignOverview.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **inline_image_activation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] 
 **mirror_active** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
+**sent_date** | **datetime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [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)
 

setup.py

@@ -15,7 +15,7 @@
 from setuptools import setup, find_packages
 
 NAME = "sib-api-v3-sdk"
-VERSION = "4.0.1"
+VERSION = "4.1.0"
 # To install the library, run the following
 #
 # python setup.py install

sib_api_v3_sdk/api/email_campaigns_api.py

@@ -436,6 +436,8 @@ def get_email_campaigns(self, **kwargs):  # noqa: E501
         :param async bool
         :param str type: Filter on the type of the campaigns
         :param str status: Filter on the status of the 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 email 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 email 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 of documents per page
         :param int offset: Index of the first document in the page
         :return: GetEmailCampaigns
@@ -460,14 +462,16 @@ def get_email_campaigns_with_http_info(self, **kwargs):  # noqa: E501
         :param async bool
         :param str type: Filter on the type of the campaigns
         :param str status: Filter on the status of the 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 email 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 email 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 of documents per page
         :param int offset: Index of the first document in the page
         :return: GetEmailCampaigns
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['type', 'status', 'limit', 'offset']  # noqa: E501
+        all_params = ['type', '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')
@@ -494,6 +498,10 @@ def get_email_campaigns_with_http_info(self, **kwargs):  # noqa: E501
             query_params.append(('type', params['type']))  # noqa: E501
         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:

sib_api_v3_sdk/models/create_attribute.py

@@ -109,7 +109,7 @@ def enumeration(self, enumeration):
     def type(self):
         """Gets the type of this CreateAttribute.  # noqa: E501
 
-        Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )  # noqa: E501
+        Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )  # noqa: E501
 
         :return: The type of this CreateAttribute.  # noqa: E501
         :rtype: str
@@ -120,12 +120,12 @@ def type(self):
     def type(self, type):
         """Sets the type of this CreateAttribute.
 
-        Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )  # noqa: E501
+        Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )  # noqa: E501
 
         :param type: The type of this CreateAttribute.  # noqa: E501
         :type: str
         """
-        allowed_values = ["text", "date", "float", "id", "category"]  # noqa: E501
+        allowed_values = ["text", "date", "float", "boolean", "id", "category"]  # noqa: E501
         if type not in allowed_values:
             raise ValueError(
                 "Invalid value for `type` ({0}), must be one of {1}"  # noqa: E501

sib_api_v3_sdk/models/get_email_campaign.py

@@ -54,6 +54,7 @@ class GetEmailCampaign(object):
         'inline_image_activation': 'bool',
         'mirror_active': 'bool',
         'recurring': 'bool',
+        'sent_date': 'datetime',
         'recipients': 'object',
         'statistics': 'object'
     }
@@ -79,11 +80,12 @@ class GetEmailCampaign(object):
         'inline_image_activation': 'inlineImageActivation',
         'mirror_active': 'mirrorActive',
         'recurring': 'recurring',
+        'sent_date': 'sentDate',
         'recipients': 'recipients',
         'statistics': 'statistics'
     }
 
-    def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, recipients=None, statistics=None):  # noqa: E501
+    def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None, recipients=None, statistics=None):  # noqa: E501
         """GetEmailCampaign - a model defined in Swagger"""  # noqa: E501
 
         self._id = None
@@ -106,6 +108,7 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch
         self._inline_image_activation = None
         self._mirror_active = None
         self._recurring = None
+        self._sent_date = None
         self._recipients = None
         self._statistics = None
         self.discriminator = None
@@ -135,6 +138,8 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch
             self.mirror_active = mirror_active
         if recurring is not None:
             self.recurring = recurring
+        if sent_date is not None:
+            self.sent_date = sent_date
         self.recipients = recipients
         self.statistics = statistics
 
@@ -638,6 +643,29 @@ def recurring(self, recurring):
 
         self._recurring = recurring
 
+    @property
+    def sent_date(self):
+        """Gets the sent_date of this GetEmailCampaign.  # noqa: E501
+
+        Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'  # noqa: E501
+
+        :return: The sent_date of this GetEmailCampaign.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._sent_date
+
+    @sent_date.setter
+    def sent_date(self, sent_date):
+        """Sets the sent_date of this GetEmailCampaign.
+
+        Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'  # noqa: E501
+
+        :param sent_date: The sent_date of this GetEmailCampaign.  # noqa: E501
+        :type: datetime
+        """
+
+        self._sent_date = sent_date
+
     @property
     def recipients(self):
         """Gets the recipients of this GetEmailCampaign.  # noqa: E501

sib_api_v3_sdk/models/get_extended_campaign_overview.py

@@ -53,7 +53,8 @@ class GetExtendedCampaignOverview(object):
         'modified_at': 'datetime',
         'inline_image_activation': 'bool',
         'mirror_active': 'bool',
-        'recurring': 'bool'
+        'recurring': 'bool',
+        'sent_date': 'datetime'
     }
 
     attribute_map = {
@@ -76,10 +77,11 @@ class GetExtendedCampaignOverview(object):
         'modified_at': 'modifiedAt',
         'inline_image_activation': 'inlineImageActivation',
         'mirror_active': 'mirrorActive',
-        'recurring': 'recurring'
+        'recurring': 'recurring',
+        'sent_date': 'sentDate'
     }
 
-    def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None):  # noqa: E501
+    def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None):  # noqa: E501
         """GetExtendedCampaignOverview - a model defined in Swagger"""  # noqa: E501
 
         self._id = None
@@ -102,6 +104,7 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch
         self._inline_image_activation = None
         self._mirror_active = None
         self._recurring = None
+        self._sent_date = None
         self.discriminator = None
 
         self.id = id
@@ -129,6 +132,8 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch
             self.mirror_active = mirror_active
         if recurring is not None:
             self.recurring = recurring
+        if sent_date is not None:
+            self.sent_date = sent_date
 
     @property
     def id(self):
@@ -630,6 +635,29 @@ def recurring(self, recurring):
 
         self._recurring = recurring
 
+    @property
+    def sent_date(self):
+        """Gets the sent_date of this GetExtendedCampaignOverview.  # noqa: E501
+
+        Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'  # noqa: E501
+
+        :return: The sent_date of this GetExtendedCampaignOverview.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._sent_date
+
+    @sent_date.setter
+    def sent_date(self, sent_date):
+        """Sets the sent_date of this GetExtendedCampaignOverview.
+
+        Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'  # noqa: E501
+
+        :param sent_date: The sent_date of this GetExtendedCampaignOverview.  # noqa: E501
+        :type: datetime
+        """
+
+        self._sent_date = sent_date
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}