Merge pull request #28 from sendinblue/feature_updated_swagger_sync

SABT functionality updates and response schemas correction

Author: aakanksha-sib

README.md

@@ -209,6 +209,7 @@ Class | Method | HTTP request | Description
  - [CreateSmtpEmail](docs/CreateSmtpEmail.md)
  - [CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
  - [CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
+ - [CreateUpdateContactModel](docs/CreateUpdateContactModel.md)
  - [CreateUpdateFolder](docs/CreateUpdateFolder.md)
  - [CreateWebhook](docs/CreateWebhook.md)
  - [CreatedProcessId](docs/CreatedProcessId.md)

docs/ContactsApi.md

@@ -142,7 +142,7 @@ void (empty response body)
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **create_contact**
-> CreateModel create_contact(create_contact)
+> CreateUpdateContactModel create_contact(create_contact)
 
 Create a contact
 
@@ -180,7 +180,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+[**CreateUpdateContactModel**](CreateUpdateContactModel.md)
 
 ### Authorization
 

docs/CreateEmailCampaign.md

@@ -9,20 +9,19 @@ Name | Type | Description | Notes
 **html_content** | **str** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional] 
 **html_url** | **str** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] 
 **template_id** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] 
-**scheduled_at** | **datetime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 
+**scheduled_at** | **datetime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
 **subject** | **str** | Subject of the campaign | 
 **reply_to** | **str** | Email on which the campaign recipients will be able to reply to | [optional] 
 **to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) |  | [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] 
 **inline_image_activation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to False]
 **mirror_active** | **bool** | Use true to enable the mirror link | [optional] 
-**recurring** | **bool** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to False]
-**type** | **str** | Type of the campaign | 
 **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'. 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] 
+**send_at_best_time** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to False]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/CreateUpdateContactModel.md

@@ -0,0 +1,10 @@
+# CreateUpdateContactModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the object created | [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/PostContactInfoContacts.md

@@ -3,8 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**success** | **list[str]** |  | 
+**success** | **list[str]** |  | [optional] 
 **failure** | **list[str]** |  | [optional] 
+**total** | **int** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [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/UpdateEmailCampaign.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **name** | **str** | Name of the campaign | [optional] 
 **html_content** | **str** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional] 
 **html_url** | **str** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [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] 
+**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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
 **subject** | **str** | Subject of the campaign | [optional] 
 **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] 
 **to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **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'}. 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] 
+**send_at_best_time** | **bool** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [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.1.3"
+VERSION = "4.2.0"
 # To install the library, run the following
 #
 # python setup.py install

sib_api_v3_sdk/__init__.py

@@ -54,6 +54,7 @@
 from sib_api_v3_sdk.models.create_smtp_email import CreateSmtpEmail
 from sib_api_v3_sdk.models.create_smtp_template import CreateSmtpTemplate
 from sib_api_v3_sdk.models.create_smtp_template_sender import CreateSmtpTemplateSender
+from sib_api_v3_sdk.models.create_update_contact_model import CreateUpdateContactModel
 from sib_api_v3_sdk.models.create_update_folder import CreateUpdateFolder
 from sib_api_v3_sdk.models.create_webhook import CreateWebhook
 from sib_api_v3_sdk.models.created_process_id import CreatedProcessId

sib_api_v3_sdk/api/contacts_api.py

@@ -261,7 +261,7 @@ def create_contact(self, create_contact, **kwargs):  # noqa: E501
 
         :param async bool
         :param CreateContact create_contact: Values to create a contact (required)
-        :return: CreateModel
+        :return: CreateUpdateContactModel
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -282,7 +282,7 @@ def create_contact_with_http_info(self, create_contact, **kwargs):  # noqa: E501
 
         :param async bool
         :param CreateContact create_contact: Values to create a contact (required)
-        :return: CreateModel
+        :return: CreateUpdateContactModel
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -340,7 +340,7 @@ def create_contact_with_http_info(self, create_contact, **kwargs):  # noqa: E501
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='CreateModel',  # noqa: E501
+            response_type='CreateUpdateContactModel',  # noqa: E501
             auth_settings=auth_settings,
             async=params.get('async'),
             _return_http_data_only=params.get('_return_http_data_only'),

sib_api_v3_sdk/models/__init__.py

@@ -35,6 +35,7 @@
 from sib_api_v3_sdk.models.create_smtp_email import CreateSmtpEmail
 from sib_api_v3_sdk.models.create_smtp_template import CreateSmtpTemplate
 from sib_api_v3_sdk.models.create_smtp_template_sender import CreateSmtpTemplateSender
+from sib_api_v3_sdk.models.create_update_contact_model import CreateUpdateContactModel
 from sib_api_v3_sdk.models.create_update_folder import CreateUpdateFolder
 from sib_api_v3_sdk.models.create_webhook import CreateWebhook
 from sib_api_v3_sdk.models.created_process_id import CreatedProcessId

sib_api_v3_sdk/models/create_email_campaign.py

@@ -48,12 +48,11 @@ class CreateEmailCampaign(object):
         'attachment_url': 'str',
         'inline_image_activation': 'bool',
         'mirror_active': 'bool',
-        'recurring': 'bool',
-        'type': 'str',
         'footer': 'str',
         'header': 'str',
         'utm_campaign': 'str',
-        'params': 'object'
+        'params': 'object',
+        'send_at_best_time': 'bool'
     }
 
     attribute_map = {
@@ -71,15 +70,14 @@ class CreateEmailCampaign(object):
         'attachment_url': 'attachmentUrl',
         'inline_image_activation': 'inlineImageActivation',
         'mirror_active': 'mirrorActive',
-        'recurring': 'recurring',
-        'type': 'type',
         'footer': 'footer',
         'header': 'header',
         'utm_campaign': 'utmCampaign',
-        'params': 'params'
+        'params': 'params',
+        'send_at_best_time': 'sendAtBestTime'
     }
 
-    def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, type=None, footer=None, header=None, utm_campaign=None, params=None):  # noqa: E501
+    def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False):  # noqa: E501
         """CreateEmailCampaign - a model defined in Swagger"""  # noqa: E501
 
         self._tag = None
@@ -96,12 +94,11 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url
         self._attachment_url = None
         self._inline_image_activation = None
         self._mirror_active = None
-        self._recurring = None
-        self._type = None
         self._footer = None
         self._header = None
         self._utm_campaign = None
         self._params = None
+        self._send_at_best_time = None
         self.discriminator = None
 
         if tag is not None:
@@ -129,9 +126,6 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url
             self.inline_image_activation = inline_image_activation
         if mirror_active is not None:
             self.mirror_active = mirror_active
-        if recurring is not None:
-            self.recurring = recurring
-        self.type = type
         if footer is not None:
             self.footer = footer
         if header is not None:
@@ -140,6 +134,8 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url
             self.utm_campaign = utm_campaign
         if params is not None:
             self.params = params
+        if send_at_best_time is not None:
+            self.send_at_best_time = send_at_best_time
 
     @property
     def tag(self):
@@ -285,7 +281,7 @@ def template_id(self, template_id):
     def scheduled_at(self):
         """Gets the scheduled_at of this CreateEmailCampaign.  # noqa: E501
 
-        Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.  # noqa: E501
+        Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).  # noqa: E501
 
         :return: The scheduled_at of this CreateEmailCampaign.  # noqa: E501
         :rtype: datetime
@@ -296,7 +292,7 @@ def scheduled_at(self):
     def scheduled_at(self, scheduled_at):
         """Sets the scheduled_at of this CreateEmailCampaign.
 
-        Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.  # noqa: E501
+        Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).  # noqa: E501
 
         :param scheduled_at: The scheduled_at of this CreateEmailCampaign.  # noqa: E501
         :type: datetime
@@ -465,60 +461,6 @@ def mirror_active(self, mirror_active):
 
         self._mirror_active = mirror_active
 
-    @property
-    def recurring(self):
-        """Gets the recurring of this CreateEmailCampaign.  # noqa: E501
-
-        For trigger campagins use false to make sure a contact receives the same campaign only once  # noqa: E501
-
-        :return: The recurring of this CreateEmailCampaign.  # noqa: E501
-        :rtype: bool
-        """
-        return self._recurring
-
-    @recurring.setter
-    def recurring(self, recurring):
-        """Sets the recurring of this CreateEmailCampaign.
-
-        For trigger campagins use false to make sure a contact receives the same campaign only once  # noqa: E501
-
-        :param recurring: The recurring of this CreateEmailCampaign.  # noqa: E501
-        :type: bool
-        """
-
-        self._recurring = recurring
-
-    @property
-    def type(self):
-        """Gets the type of this CreateEmailCampaign.  # noqa: E501
-
-        Type of the campaign  # noqa: E501
-
-        :return: The type of this CreateEmailCampaign.  # noqa: E501
-        :rtype: str
-        """
-        return self._type
-
-    @type.setter
-    def type(self, type):
-        """Sets the type of this CreateEmailCampaign.
-
-        Type of the campaign  # noqa: E501
-
-        :param type: The type of this CreateEmailCampaign.  # noqa: E501
-        :type: str
-        """
-        if type is None:
-            raise ValueError("Invalid value for `type`, must not be `None`")  # noqa: E501
-        allowed_values = ["classic", "trigger"]  # noqa: E501
-        if type not in allowed_values:
-            raise ValueError(
-                "Invalid value for `type` ({0}), must be one of {1}"  # noqa: E501
-                .format(type, allowed_values)
-            )
-
-        self._type = type
-
     @property
     def footer(self):
         """Gets the footer of this CreateEmailCampaign.  # noqa: E501
@@ -611,6 +553,29 @@ def params(self, params):
 
         self._params = params
 
+    @property
+    def send_at_best_time(self):
+        """Gets the send_at_best_time of this CreateEmailCampaign.  # noqa: E501
+
+        Set this to true if you want to send your campaign at best time.  # noqa: E501
+
+        :return: The send_at_best_time of this CreateEmailCampaign.  # noqa: E501
+        :rtype: bool
+        """
+        return self._send_at_best_time
+
+    @send_at_best_time.setter
+    def send_at_best_time(self, send_at_best_time):
+        """Sets the send_at_best_time of this CreateEmailCampaign.
+
+        Set this to true if you want to send your campaign at best time.  # noqa: E501
+
+        :param send_at_best_time: The send_at_best_time of this CreateEmailCampaign.  # noqa: E501
+        :type: bool
+        """
+
+        self._send_at_best_time = send_at_best_time
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}