Merge pull request #16 from sendinblue/feature_updated_swagger_sync

Delete contact api added

Author: aakanksha-sib

README.md

@@ -58,19 +58,20 @@ from sib_api_v3_sdk.rest import ApiException
 from pprint import pprint
 
 # Configure API key authorization: api-key
-sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'
+configuration = sib_api_v3_sdk.Configuration()
+configuration.api_key['api-key'] = 'YOUR_API_KEY'
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# sib_api_v3_sdk.configuration.api_key_prefix['api-key'] = 'Bearer'
+# configuration.api_key_prefix['api-key'] = 'Bearer'
+
 # create an instance of the API class
-api_instance = sib_api_v3_sdk.AccountApi()
+api_instance = sib_api_v3_sdk.AccountApi(sib_api_v3_sdk.ApiClient(configuration))
 
 try:
     # Get your account informations, plans and credits details
     api_response = api_instance.get_account()
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling AccountApi->get_account: %s\n" % e)
-
 ```
 
 ## Documentation for API Endpoints
@@ -90,6 +91,7 @@ Class | Method | HTTP request | Description
 *ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 *ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
 *ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
+*ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Deletes a contact
 *ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
 *ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
 *ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes

docs/ContactsApi.md

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
 [**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
+[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Deletes a contact
 [**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
 [**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
 [**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
@@ -349,6 +350,57 @@ 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)
 
+# **delete_contact**
+> delete_contact(email)
+
+Deletes a contact
+
+### Example
+```python
+from __future__ import print_function
+import time
+import sib_api_v3_sdk
+from sib_api_v3_sdk.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: api-key
+configuration = sib_api_v3_sdk.Configuration()
+configuration.api_key['api-key'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['api-key'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
+email = 'email_example' # str | Email (urlencoded) of the contact
+
+try:
+    # Deletes a contact
+    api_instance.delete_contact(email)
+except ApiException as e:
+    print("Exception when calling ContactsApi->delete_contact: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **str**| Email (urlencoded) of the contact | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[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)
+
 # **delete_folder**
 > delete_folder(folder_id)
 

docs/GetAccountPlan.md

@@ -4,10 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **str** | Displays the plan type of the user | 
-**credits_type** | **str** | This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | 
-**credits** | **float** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. | 
-**start_date** | **date** | Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional] 
-**end_date** | **date** | Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional] 
+**credits_type** | **str** | This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | 
+**credits** | **float** | Remaining credits of the user | 
+**start_date** | **date** | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional] 
+**end_date** | **date** | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional] 
+**user_limit** | **int** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [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 = "3.0.0"
+VERSION = "3.0.1"
 # To install the library, run the following
 #
 # python setup.py install

sib_api_v3_sdk/api/contacts_api.py

@@ -647,6 +647,103 @@ def delete_attribute_with_http_info(self, attribute_category, attribute_name, **
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def delete_contact(self, email, **kwargs):  # noqa: E501
+        """Deletes a contact  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async=True
+        >>> thread = api.delete_contact(email, async=True)
+        >>> result = thread.get()
+
+        :param async bool
+        :param str email: Email (urlencoded) of the contact (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.delete_contact_with_http_info(email, **kwargs)  # noqa: E501
+        else:
+            (data) = self.delete_contact_with_http_info(email, **kwargs)  # noqa: E501
+            return data
+
+    def delete_contact_with_http_info(self, email, **kwargs):  # noqa: E501
+        """Deletes a contact  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async=True
+        >>> thread = api.delete_contact_with_http_info(email, async=True)
+        >>> result = thread.get()
+
+        :param async bool
+        :param str email: Email (urlencoded) of the contact (required)
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['email']  # noqa: E501
+        all_params.append('async')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method delete_contact" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'email' is set
+        if ('email' not in params or
+                params['email'] is None):
+            raise ValueError("Missing the required parameter `email` when calling `delete_contact`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'email' in params:
+            path_params['email'] = params['email']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['api-key']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/contacts/{email}', 'DELETE',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # noqa: E501
+            auth_settings=auth_settings,
+            async=params.get('async'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def delete_folder(self, folder_id, **kwargs):  # noqa: E501
         """Delete a folder (and all its lists)  # noqa: E501
 

sib_api_v3_sdk/models/get_account_plan.py

@@ -35,25 +35,28 @@ class GetAccountPlan(object):
         'credits_type': 'str',
         'credits': 'float',
         'start_date': 'date',
-        'end_date': 'date'
+        'end_date': 'date',
+        'user_limit': 'int'
     }
 
     attribute_map = {
         'type': 'type',
         'credits_type': 'creditsType',
         'credits': 'credits',
         'start_date': 'startDate',
-        'end_date': 'endDate'
+        'end_date': 'endDate',
+        'user_limit': 'userLimit'
     }
 
-    def __init__(self, type=None, credits_type=None, credits=None, start_date=None, end_date=None):  # noqa: E501
+    def __init__(self, type=None, credits_type=None, credits=None, start_date=None, end_date=None, user_limit=None):  # noqa: E501
         """GetAccountPlan - a model defined in Swagger"""  # noqa: E501
 
         self._type = None
         self._credits_type = None
         self._credits = None
         self._start_date = None
         self._end_date = None
+        self._user_limit = None
         self.discriminator = None
 
         self.type = type
@@ -63,6 +66,8 @@ def __init__(self, type=None, credits_type=None, credits=None, start_date=None,
             self.start_date = start_date
         if end_date is not None:
             self.end_date = end_date
+        if user_limit is not None:
+            self.user_limit = user_limit
 
     @property
     def type(self):
@@ -86,7 +91,7 @@ def type(self, type):
         """
         if type is None:
             raise ValueError("Invalid value for `type`, must not be `None`")  # noqa: E501
-        allowed_values = ["payAsYouGo", "unlimited", "free", "subscription", "sms", "reseller"]  # noqa: E501
+        allowed_values = ["payAsYouGo", "free", "subscription", "sms", "reseller"]  # noqa: E501
         if type not in allowed_values:
             raise ValueError(
                 "Invalid value for `type` ({0}), must be one of {1}"  # noqa: E501
@@ -99,7 +104,7 @@ def type(self, type):
     def credits_type(self):
         """Gets the credits_type of this GetAccountPlan.  # noqa: E501
 
-        This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.  # noqa: E501
+        This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.  # noqa: E501
 
         :return: The credits_type of this GetAccountPlan.  # noqa: E501
         :rtype: str
@@ -110,14 +115,14 @@ def credits_type(self):
     def credits_type(self, credits_type):
         """Sets the credits_type of this GetAccountPlan.
 
-        This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.  # noqa: E501
+        This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.  # noqa: E501
 
         :param credits_type: The credits_type of this GetAccountPlan.  # noqa: E501
         :type: str
         """
         if credits_type is None:
             raise ValueError("Invalid value for `credits_type`, must not be `None`")  # noqa: E501
-        allowed_values = ["userLimit", "sendLimit"]  # noqa: E501
+        allowed_values = ["sendLimit"]  # noqa: E501
         if credits_type not in allowed_values:
             raise ValueError(
                 "Invalid value for `credits_type` ({0}), must be one of {1}"  # noqa: E501
@@ -130,7 +135,7 @@ def credits_type(self, credits_type):
     def credits(self):
         """Gets the credits of this GetAccountPlan.  # noqa: E501
 
-        Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan.  # noqa: E501
+        Remaining credits of the user  # noqa: E501
 
         :return: The credits of this GetAccountPlan.  # noqa: E501
         :rtype: float
@@ -141,7 +146,7 @@ def credits(self):
     def credits(self, credits):
         """Sets the credits of this GetAccountPlan.
 
-        Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan.  # noqa: E501
+        Remaining credits of the user  # noqa: E501
 
         :param credits: The credits of this GetAccountPlan.  # noqa: E501
         :type: float
@@ -155,7 +160,7 @@ def credits(self, credits):
     def start_date(self):
         """Gets the start_date of this GetAccountPlan.  # noqa: E501
 
-        Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type)  # noqa: E501
+        Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type)  # noqa: E501
 
         :return: The start_date of this GetAccountPlan.  # noqa: E501
         :rtype: date
@@ -166,7 +171,7 @@ def start_date(self):
     def start_date(self, start_date):
         """Sets the start_date of this GetAccountPlan.
 
-        Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type)  # noqa: E501
+        Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type)  # noqa: E501
 
         :param start_date: The start_date of this GetAccountPlan.  # noqa: E501
         :type: date
@@ -178,7 +183,7 @@ def start_date(self, start_date):
     def end_date(self):
         """Gets the end_date of this GetAccountPlan.  # noqa: E501
 
-        Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type)  # noqa: E501
+        Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type)  # noqa: E501
 
         :return: The end_date of this GetAccountPlan.  # noqa: E501
         :rtype: date
@@ -189,14 +194,37 @@ def end_date(self):
     def end_date(self, end_date):
         """Sets the end_date of this GetAccountPlan.
 
-        Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type)  # noqa: E501
+        Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type)  # noqa: E501
 
         :param end_date: The end_date of this GetAccountPlan.  # noqa: E501
         :type: date
         """
 
         self._end_date = end_date
 
+    @property
+    def user_limit(self):
+        """Gets the user_limit of this GetAccountPlan.  # noqa: E501
+
+        Only in case of reseller account. It implies the total number of child accounts you can add to your account.  # noqa: E501
+
+        :return: The user_limit of this GetAccountPlan.  # noqa: E501
+        :rtype: int
+        """
+        return self._user_limit
+
+    @user_limit.setter
+    def user_limit(self, user_limit):
+        """Sets the user_limit of this GetAccountPlan.
+
+        Only in case of reseller account. It implies the total number of child accounts you can add to your account.  # noqa: E501
+
+        :param user_limit: The user_limit of this GetAccountPlan.  # noqa: E501
+        :type: int
+        """
+
+        self._user_limit = user_limit
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}