Merge pull request #26 from sendinblue/feature_updated_swagger_sync

aakanksha-sib · web-flow · commit 192728172141 · 2019-01-10T16:51:58.000+05:30
Swagger updates for sms api
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 SendinBlue
+Copyright (c) 2019 SendinBlue
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.
diff --git a/docs/CreateWebhook.md b/docs/CreateWebhook.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **str** | URL of the webhook | 
 **description** | **str** | Description of the webhook | [optional] 
-**events** | **list[str]** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition &amp; delivered | [optional] 
+**events** | **list[str]** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition &amp; delivered | 
 **type** | **str** | Type of the webhook | [optional] [default to 'transactional']
 
 [[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/GetSmsEventReportEvents.md b/docs/GetSmsEventReportEvents.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phone_number** | **str** | Phone number which has generated the event | 
-**date** | **date** | Date on which the event has been generated | 
+**date** | **datetime** | UTC date-time on which the event has been generated | 
 **message_id** | **str** | Message ID which generated the event | 
 **event** | **str** | Event which occurred | 
 **reason** | **str** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 
diff --git a/docs/RequestContactImport.md b/docs/RequestContactImport.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **email_blacklist** | **bool** | To blacklist all the contacts for email | [optional] [default to False]
 **sms_blacklist** | **bool** | To blacklist all the contacts for sms | [optional] [default to False]
 **update_existing_contacts** | **bool** | To facilitate the choice to update the existing contacts | [optional] [default to True]
+**empty_contacts_attributes** | **bool** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes &#x3D; true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, &amp; emptyContactsAttributes &#x3D; false means the empty fields will not affect your existing data ( only available if &#x60;updateExistingContacts&#x60; set to true ) | [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)
 
diff --git a/docs/RequestSMSRecipientExport.md b/docs/RequestSMSRecipientExport.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **notify_url** | **str** | URL that will be called once the export process is finished | [optional] 
-**recipients_type** | **str** | Filter the recipients based on how they interacted with the campaign | [default to 'all']
+**recipients_type** | **str** | Filter the recipients based on how they interacted with the campaign | 
 
 [[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/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md
@@ -396,7 +396,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)
 
 # **send_test_sms**
-> send_test_sms(campaign_id, send_test_sms)
+> send_test_sms(campaign_id, phone_number)
 
 Send an SMS
 
@@ -417,11 +417,11 @@ 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))
 campaign_id = 789 # int | Id of the SMS campaign
-send_test_sms = sib_api_v3_sdk.SendTestSms() # SendTestSms | Mobile number to which send the test
+phone_number = sib_api_v3_sdk.SendTestSms() # SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
 
 try:
     # Send an SMS
-    api_instance.send_test_sms(campaign_id, send_test_sms)
+    api_instance.send_test_sms(campaign_id, phone_number)
 except ApiException as e:
     print("Exception when calling SMSCampaignsApi->send_test_sms: %s\n" % e)
 ```
@@ -431,7 +431,7 @@ except ApiException as e:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **campaign_id** | **int**| Id of the SMS campaign | 
- **send_test_sms** | [**SendTestSms**](SendTestSms.md)| Mobile number to which send the test | 
+ **phone_number** | [**SendTestSms**](SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | 
 
 ### Return type
 
diff --git a/docs/SendReportEmail.md b/docs/SendReportEmail.md
@@ -3,12 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subject** | **str** | Subject of the email message | [optional] 
-**to** | **list[str]** | Email addresses of the recipients | [optional] 
-**content_type** | **str** | Type of the message body | [optional] 
+**subject** | **str** | Subject of the email message | 
+**to** | **list[str]** | Email addresses of the recipients | 
+**content_type** | **str** | Type of the message body | [optional] [default to 'html']
 **bcc** | **list[str]** | Email addresses of the recipients in bcc | [optional] 
 **cc** | **list[str]** | Email addresses of the recipients in cc | [optional] 
-**body** | **str** | Body of the email message | [optional] 
+**body** | **str** | Body of the email message | 
 
 [[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/SendSms.md b/docs/SendSms.md
@@ -5,6 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference** | **str** |  | 
 **message_id** | **int** |  | 
+**sms_count** | **int** | Count of SMS&#39;s to send multiple text messages | [optional] 
+**used_credits** | **float** | SMS credits used per text message | [optional] 
+**remaining_credits** | **float** | Remaining SMS credits of the user | [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/SendSmtpEmail.md b/docs/SendSmtpEmail.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **text_content** | **str** | Plain Text body of the message ( Ignored if &#39;templateId&#39; is passed ) | [optional] 
 **subject** | **str** | Subject of the message. Mandatory if &#39;templateId&#39; 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, [{&#39;url&#39;:&#39;https://attachment.domain.com/myAttachmentFromUrl.jpg&#39;, &#39;name&#39;:&#39;My attachment 1&#39;}, {&#39;content&#39;:&#39;base64 exmaple content&#39;, &#39;name&#39;:&#39;My attachment 2&#39;}]. 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 &#39;templateId&#39; is passed ) | [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, [{&#39;url&#39;:&#39;https://attachment.domain.com/myAttachmentFromUrl.jpg&#39;, &#39;name&#39;:&#39;My attachment 1&#39;}, {&#39;content&#39;:&#39;base64 exmaple content&#39;, &#39;name&#39;:&#39;My attachment 2&#39;}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( Ignored if &#39;templateId&#39; is passed ) | [optional] 
 **headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;sender.ip&#39; header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {&#39;Content-Type&#39;:&#39;text/html&#39;, &#39;charset&#39;:&#39;iso-8859-1&#39;, &#39;sender.ip&#39;:&#39;1.2.3.4&#39;} | [optional] 
 **template_id** | **int** | Id of the template | [optional] 
 **params** | **object** | Pass the set of attributes to customize the template. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;}. It&#39;s considered only if template is in New Template Language format. | [optional] 
diff --git a/docs/SendTestSms.md b/docs/SendTestSms.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**phone_numbers** | **list[str]** | Mobile number with the country code to send test SMS. The mobile number defined here must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 
+**phone_number** | **str** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | [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/UpdateCampaignStatus.md b/docs/UpdateCampaignStatus.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | **str** |  | [optional] 
+**status** | **str** | Note:- replicateTemplate status will be available only for template type campaigns. | [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/UpdateContact.md b/docs/UpdateContact.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. For eg. {&#39;FNAME&#39;:&#39;Ellie&#39;, &#39;LNAME&#39;:&#39;Roger&#39;} | [optional] 
+**attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { &#39;EMAIL&#39;:&#39;newemail@domain.com&#39;, &#39;FNAME&#39;:&#39;Ellie&#39;, &#39;LNAME&#39;:&#39;Roger&#39;} | [optional] 
 **email_blacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted &#x3D; true) | [optional] 
 **sms_blacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted &#x3D; true) | [optional] 
 **list_ids** | **list[int]** | Ids of the lists to add the contact to | [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.2"
+VERSION = "4.1.3"
 # 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
@@ -750,45 +750,45 @@ def send_sms_report_with_http_info(self, campaign_id, send_report, **kwargs):  #
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def send_test_sms(self, campaign_id, send_test_sms, **kwargs):  # noqa: E501
+    def send_test_sms(self, campaign_id, phone_number, **kwargs):  # noqa: E501
         """Send an SMS  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async=True
-        >>> thread = api.send_test_sms(campaign_id, send_test_sms, async=True)
+        >>> thread = api.send_test_sms(campaign_id, phone_number, async=True)
         >>> result = thread.get()
 
         :param async bool
         :param int campaign_id: Id of the SMS campaign (required)
-        :param SendTestSms send_test_sms: Mobile number to which send the test (required)
+        :param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
         """
         kwargs['_return_http_data_only'] = True
         if kwargs.get('async'):
-            return self.send_test_sms_with_http_info(campaign_id, send_test_sms, **kwargs)  # noqa: E501
+            return self.send_test_sms_with_http_info(campaign_id, phone_number, **kwargs)  # noqa: E501
         else:
-            (data) = self.send_test_sms_with_http_info(campaign_id, send_test_sms, **kwargs)  # noqa: E501
+            (data) = self.send_test_sms_with_http_info(campaign_id, phone_number, **kwargs)  # noqa: E501
             return data
 
-    def send_test_sms_with_http_info(self, campaign_id, send_test_sms, **kwargs):  # noqa: E501
+    def send_test_sms_with_http_info(self, campaign_id, phone_number, **kwargs):  # noqa: E501
         """Send an SMS  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async=True
-        >>> thread = api.send_test_sms_with_http_info(campaign_id, send_test_sms, async=True)
+        >>> thread = api.send_test_sms_with_http_info(campaign_id, phone_number, async=True)
         >>> result = thread.get()
 
         :param async bool
         :param int campaign_id: Id of the SMS campaign (required)
-        :param SendTestSms send_test_sms: Mobile number to which send the test (required)
+        :param SendTestSms phone_number: Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)
         :return: None
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['campaign_id', 'send_test_sms']  # noqa: E501
+        all_params = ['campaign_id', 'phone_number']  # noqa: E501
         all_params.append('async')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -807,10 +807,10 @@ def send_test_sms_with_http_info(self, campaign_id, send_test_sms, **kwargs):  #
         if ('campaign_id' not in params or
                 params['campaign_id'] is None):
             raise ValueError("Missing the required parameter `campaign_id` when calling `send_test_sms`")  # noqa: E501
-        # verify the required parameter 'send_test_sms' is set
-        if ('send_test_sms' not in params or
-                params['send_test_sms'] is None):
-            raise ValueError("Missing the required parameter `send_test_sms` when calling `send_test_sms`")  # noqa: E501
+        # verify the required parameter 'phone_number' is set
+        if ('phone_number' not in params or
+                params['phone_number'] is None):
+            raise ValueError("Missing the required parameter `phone_number` when calling `send_test_sms`")  # noqa: E501
 
         collection_formats = {}
 
@@ -826,8 +826,8 @@ def send_test_sms_with_http_info(self, campaign_id, send_test_sms, **kwargs):  #
         local_var_files = {}
 
         body_params = None
-        if 'send_test_sms' in params:
-            body_params = params['send_test_sms']
+        if 'phone_number' in params:
+            body_params = params['phone_number']
         # HTTP header `Accept`
         header_params['Accept'] = self.api_client.select_header_accept(
             ['application/json'])  # noqa: E501
diff --git a/sib_api_v3_sdk/models/create_webhook.py b/sib_api_v3_sdk/models/create_webhook.py
@@ -56,8 +56,7 @@ def __init__(self, url=None, description=None, events=None, type='transactional'
         self.url = url
         if description is not None:
             self.description = description
-        if events is not None:
-            self.events = events
+        self.events = events
         if type is not None:
             self.type = type
 
@@ -129,6 +128,8 @@ def events(self, events):
         :param events: The events of this CreateWebhook.  # noqa: E501
         :type: list[str]
         """
+        if events is None:
+            raise ValueError("Invalid value for `events`, must not be `None`")  # noqa: E501
         allowed_values = ["hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition"]  # noqa: E501
         if not set(events).issubset(set(allowed_values)):
             raise ValueError(
diff --git a/sib_api_v3_sdk/models/get_sms_event_report_events.py b/sib_api_v3_sdk/models/get_sms_event_report_events.py
@@ -32,7 +32,7 @@ class GetSmsEventReportEvents(object):
     """
     swagger_types = {
         'phone_number': 'str',
-        'date': 'date',
+        'date': 'datetime',
         'message_id': 'str',
         'event': 'str',
         'reason': 'str',
@@ -102,21 +102,21 @@ def phone_number(self, phone_number):
     def date(self):
         """Gets the date of this GetSmsEventReportEvents.  # noqa: E501
 
-        Date on which the event has been generated  # noqa: E501
+        UTC date-time on which the event has been generated  # noqa: E501
 
         :return: The date of this GetSmsEventReportEvents.  # noqa: E501
-        :rtype: date
+        :rtype: datetime
         """
         return self._date
 
     @date.setter
     def date(self, date):
         """Sets the date of this GetSmsEventReportEvents.
 
-        Date on which the event has been generated  # noqa: E501
+        UTC date-time on which the event has been generated  # noqa: E501
 
         :param date: The date of this GetSmsEventReportEvents.  # noqa: E501
-        :type: date
+        :type: datetime
         """
         if date is None:
             raise ValueError("Invalid value for `date`, must not be `None`")  # noqa: E501
diff --git a/sib_api_v3_sdk/models/request_contact_import.py b/sib_api_v3_sdk/models/request_contact_import.py
diff --git a/sib_api_v3_sdk/models/request_sms_recipient_export.py b/sib_api_v3_sdk/models/request_sms_recipient_export.py
diff --git a/sib_api_v3_sdk/models/send_report_email.py b/sib_api_v3_sdk/models/send_report_email.py
diff --git a/sib_api_v3_sdk/models/send_sms.py b/sib_api_v3_sdk/models/send_sms.py
diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py
diff --git a/sib_api_v3_sdk/models/send_test_sms.py b/sib_api_v3_sdk/models/send_test_sms.py
diff --git a/sib_api_v3_sdk/models/update_campaign_status.py b/sib_api_v3_sdk/models/update_campaign_status.py
diff --git a/sib_api_v3_sdk/models/update_contact.py b/sib_api_v3_sdk/models/update_contact.py
