Swagger updates for additional parameters in email campaigns

aakanksha-sib · aakanksha-sib · commit e3e190911960 · 2018-10-16T11:57:41.000+05:30
diff --git a/docs/CreateEmailCampaign.md b/docs/CreateEmailCampaign.md
@@ -6,12 +6,13 @@ Name | Type | Description | Notes
 **tag** | **str** | Tag of the campaign | [optional] 
 **sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) |  | 
 **name** | **str** | Name of the campaign | 
-**html_content** | **str** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional] 
-**html_url** | **str** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional] 
+**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 &#39;active&#39;. 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] 
 **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, e.g. if you want to include the first name and last name of your recipient, use {FNAME} {LNAME}. These attributes must already exist in your contact database | [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 &#39;params&#39; 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]
@@ -21,6 +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, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;}. Only available if &#39;type&#39; is &#39;classic&#39; | [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/CreateSmtpTemplate.md b/docs/CreateSmtpTemplate.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **html_url** | **str** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
 **subject** | **str** | Subject of the template | 
 **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] 
-**to_field** | **str** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account | [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 &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [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] 
 **is_active** | **bool** | Status of template. isActive &#x3D; true means template is active and isActive &#x3D; false means template is inactive | [optional] 
 
diff --git a/docs/UpdateEmailCampaign.md b/docs/UpdateEmailCampaign.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **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] 
 **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** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account | [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 &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.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** | Status of inline image. inlineImageActivation &#x3D; false means image can’t be embedded, &amp; inlineImageActivation &#x3D; true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to False]
@@ -20,6 +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 &#39;classic&#39; campaign. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;}. | [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/UpdateSmtpTemplate.md b/docs/UpdateSmtpTemplate.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **html_url** | **str** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
 **subject** | **str** | Subject of the email | [optional] 
 **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] 
-**to_field** | **str** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These attributes must already exist in contacts database | [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 &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [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] 
 **is_active** | **bool** | Status of the template. isActive &#x3D; false means template is inactive, isActive &#x3D; true means template is active | [optional] 
 
diff --git a/setup.py b/setup.py
@@ -15,7 +15,7 @@
 from setuptools import setup, find_packages
 
 NAME = "sib-api-v3-sdk"
-VERSION = "4.1.0"
+VERSION = "4.1.1"
 # To install the library, run the following
 #
 # python setup.py install
diff --git a/sib_api_v3_sdk/models/create_email_campaign.py b/sib_api_v3_sdk/models/create_email_campaign.py
@@ -39,6 +39,7 @@ class CreateEmailCampaign(object):
         'name': 'str',
         'html_content': 'str',
         'html_url': 'str',
+        'template_id': 'int',
         'scheduled_at': 'datetime',
         'subject': 'str',
         'reply_to': 'str',
@@ -51,7 +52,8 @@ class CreateEmailCampaign(object):
         'type': 'str',
         'footer': 'str',
         'header': 'str',
-        'utm_campaign': 'str'
+        'utm_campaign': 'str',
+        'params': 'object'
     }
 
     attribute_map = {
@@ -60,6 +62,7 @@ class CreateEmailCampaign(object):
         'name': 'name',
         'html_content': 'htmlContent',
         'html_url': 'htmlUrl',
+        'template_id': 'templateId',
         'scheduled_at': 'scheduledAt',
         'subject': 'subject',
         'reply_to': 'replyTo',
@@ -72,17 +75,19 @@ class CreateEmailCampaign(object):
         'type': 'type',
         'footer': 'footer',
         'header': 'header',
-        'utm_campaign': 'utmCampaign'
+        'utm_campaign': 'utmCampaign',
+        'params': 'params'
     }
 
-    def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=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):  # 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, recurring=False, type=None, footer=None, header=None, utm_campaign=None, params=None):  # noqa: E501
         """CreateEmailCampaign - a model defined in Swagger"""  # noqa: E501
 
         self._tag = None
         self._sender = None
         self._name = None
         self._html_content = None
         self._html_url = None
+        self._template_id = None
         self._scheduled_at = None
         self._subject = None
         self._reply_to = None
@@ -96,6 +101,7 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url
         self._footer = None
         self._header = None
         self._utm_campaign = None
+        self._params = None
         self.discriminator = None
 
         if tag is not None:
@@ -106,6 +112,8 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url
             self.html_content = html_content
         if html_url is not None:
             self.html_url = html_url
+        if template_id is not None:
+            self.template_id = template_id
         if scheduled_at is not None:
             self.scheduled_at = scheduled_at
         self.subject = subject
@@ -130,6 +138,8 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url
             self.header = header
         if utm_campaign is not None:
             self.utm_campaign = utm_campaign
+        if params is not None:
+            self.params = params
 
     @property
     def tag(self):
@@ -206,7 +216,7 @@ def name(self, name):
     def html_content(self):
         """Gets the html_content of this CreateEmailCampaign.  # noqa: E501
 
-        Mandatory if htmlUrl is empty. Body of the message (HTML)  # noqa: E501
+        Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)  # noqa: E501
 
         :return: The html_content of this CreateEmailCampaign.  # noqa: E501
         :rtype: str
@@ -217,7 +227,7 @@ def html_content(self):
     def html_content(self, html_content):
         """Sets the html_content of this CreateEmailCampaign.
 
-        Mandatory if htmlUrl is empty. Body of the message (HTML)  # noqa: E501
+        Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)  # noqa: E501
 
         :param html_content: The html_content of this CreateEmailCampaign.  # noqa: E501
         :type: str
@@ -229,7 +239,7 @@ def html_content(self, html_content):
     def html_url(self):
         """Gets the html_url of this CreateEmailCampaign.  # noqa: E501
 
-        Mandatory if htmlContent is empty. Url to the message (HTML)  # noqa: E501
+        Mandatory if htmlContent and templateId are empty. Url to the message (HTML)  # noqa: E501
 
         :return: The html_url of this CreateEmailCampaign.  # noqa: E501
         :rtype: str
@@ -240,14 +250,37 @@ def html_url(self):
     def html_url(self, html_url):
         """Sets the html_url of this CreateEmailCampaign.
 
-        Mandatory if htmlContent is empty. Url to the message (HTML)  # noqa: E501
+        Mandatory if htmlContent and templateId are empty. Url to the message (HTML)  # noqa: E501
 
         :param html_url: The html_url of this CreateEmailCampaign.  # noqa: E501
         :type: str
         """
 
         self._html_url = html_url
 
+    @property
+    def template_id(self):
+        """Gets the template_id of this CreateEmailCampaign.  # noqa: E501
+
+        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.  # noqa: E501
+
+        :return: The template_id of this CreateEmailCampaign.  # noqa: E501
+        :rtype: int
+        """
+        return self._template_id
+
+    @template_id.setter
+    def template_id(self, template_id):
+        """Sets the template_id of this CreateEmailCampaign.
+
+        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.  # noqa: E501
+
+        :param template_id: The template_id of this CreateEmailCampaign.  # noqa: E501
+        :type: int
+        """
+
+        self._template_id = template_id
+
     @property
     def scheduled_at(self):
         """Gets the scheduled_at of this CreateEmailCampaign.  # noqa: E501
@@ -323,7 +356,7 @@ def reply_to(self, reply_to):
     def to_field(self):
         """Gets the to_field of this CreateEmailCampaign.  # noqa: E501
 
-        To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use {FNAME} {LNAME}. These attributes must already exist in your contact database  # noqa: E501
+        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  # noqa: E501
 
         :return: The to_field of this CreateEmailCampaign.  # noqa: E501
         :rtype: str
@@ -334,7 +367,7 @@ def to_field(self):
     def to_field(self, to_field):
         """Sets the to_field of this CreateEmailCampaign.
 
-        To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use {FNAME} {LNAME}. These attributes must already exist in your contact database  # noqa: E501
+        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  # noqa: E501
 
         :param to_field: The to_field of this CreateEmailCampaign.  # noqa: E501
         :type: str
@@ -555,6 +588,29 @@ def utm_campaign(self, utm_campaign):
 
         self._utm_campaign = utm_campaign
 
+    @property
+    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
+
+        :return: The params of this CreateEmailCampaign.  # noqa: E501
+        :rtype: object
+        """
+        return self._params
+
+    @params.setter
+    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
+
+        :param params: The params of this CreateEmailCampaign.  # noqa: E501
+        :type: object
+        """
+
+        self._params = params
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}
diff --git a/sib_api_v3_sdk/models/create_smtp_template.py b/sib_api_v3_sdk/models/create_smtp_template.py
@@ -260,7 +260,7 @@ def reply_to(self, reply_to):
     def to_field(self):
         """Gets the to_field of this CreateSmtpTemplate.  # noqa: E501
 
-        This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account  # noqa: E501
+        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  # noqa: E501
 
         :return: The to_field of this CreateSmtpTemplate.  # noqa: E501
         :rtype: str
@@ -271,7 +271,7 @@ def to_field(self):
     def to_field(self, to_field):
         """Sets the to_field of this CreateSmtpTemplate.
 
-        This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account  # noqa: E501
+        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  # noqa: E501
 
         :param to_field: The to_field of this CreateSmtpTemplate.  # 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
diff --git a/sib_api_v3_sdk/models/update_smtp_template.py b/sib_api_v3_sdk/models/update_smtp_template.py

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`from setuptools import setup, find_packages`
`16`	`16`
`17`	`17`	`NAME = "sib-api-v3-sdk"`
`18`		`-VERSION = "4.1.0"`
	`18`	`+VERSION = "4.1.1"`
`19`	`19`	`# To install the library, run the following`
`20`	`20`	`#`
`21`	`21`	`# python setup.py install`