Merge pull request #39 from sendinblue/feature_updated_swagger_sync

Swagger updates for new reseller route

Author: aakanksha-sib

README.md

@@ -154,8 +154,9 @@ Class | Method | HTTP request | Description
 *ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
 *ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
 *ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
-*ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Generates a session token which will remain valid for a short period of time only.
+*ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
 *ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
+*ResellerApi* | [**update_child_account_status**](docs/ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
 *ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
 *ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
 *SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
@@ -334,6 +335,7 @@ Class | Method | HTTP request | Description
  - [UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
  - [UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
  - [UpdateChild](docs/UpdateChild.md)
+ - [UpdateChildAccountStatus](docs/UpdateChildAccountStatus.md)
  - [UpdateChildDomain](docs/UpdateChildDomain.md)
  - [UpdateContact](docs/UpdateContact.md)
  - [UpdateEmailCampaign](docs/UpdateEmailCampaign.md)

docs/ContactsApi.md

@@ -627,7 +627,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
 
 # 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
+email = 'email_example' # str | Email (urlencoded) of the contact OR its SMS attribute value
 
 try:
     # Retrieves contact informations
@@ -641,7 +641,7 @@ except ApiException as e:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **email** | **str**| Email (urlencoded) of the contact | 
+ **email** | **str**| Email (urlencoded) of the contact OR its SMS attribute value | 
 
 ### Return type
 

docs/ResellerApi.md

@@ -14,8 +14,9 @@ Method | HTTP request | Description
 [**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
 [**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
 [**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
-[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Generates a session token which will remain valid for a short period of time only.
+[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
 [**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
+[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
 [**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
 [**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
 
@@ -594,7 +595,9 @@ This endpoint does not need any parameter.
 # **get_sso_token**
 > GetSsoToken get_sso_token(child_auth_key)
 
-Generates a session token which will remain valid for a short period of time only.
+Get session token to access Sendinblue (SSO)
+
+It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
 
 ### Example
 ```python
@@ -620,7 +623,7 @@ api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration
 child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child
 
 try:
-    # Generates a session token which will remain valid for a short period of time only.
+    # Get session token to access Sendinblue (SSO)
     api_response = api_instance.get_sso_token(child_auth_key)
     pprint(api_response)
 except ApiException as e:
@@ -707,6 +710,64 @@ 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)
 
+# **update_child_account_status**
+> update_child_account_status(child_auth_key, update_child_account_status)
+
+Updates infos of reseller's child account status based on the childAuthKey supplied
+
+### 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'
+# Configure API key authorization: partner-key
+configuration = sib_api_v3_sdk.Configuration()
+configuration.api_key['partner-key'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['partner-key'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = sib_api_v3_sdk.ResellerApi(sib_api_v3_sdk.ApiClient(configuration))
+child_auth_key = 'child_auth_key_example' # str | auth key of reseller's child
+update_child_account_status = sib_api_v3_sdk.UpdateChildAccountStatus() # UpdateChildAccountStatus | values to update in child account status
+
+try:
+    # Updates infos of reseller's child account status based on the childAuthKey supplied
+    api_instance.update_child_account_status(child_auth_key, update_child_account_status)
+except ApiException as e:
+    print("Exception when calling ResellerApi->update_child_account_status: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_auth_key** | **str**| auth key of reseller's child | 
+ **update_child_account_status** | [**UpdateChildAccountStatus**](UpdateChildAccountStatus.md)| values to update in child account status | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-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)
+
 # **update_child_domain**
 > update_child_domain(child_auth_key, domain_name, update_child_domain)
 

docs/SendSmtpEmail.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **text_content** | **str** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] 
 **subject** | **str** | Subject of the message. Mandatory if 'templateId' 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, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. 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 ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [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, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. 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, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] 
 **headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] 
 **template_id** | **int** | Id of the template | [optional] 
 **params** | **object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional] 

docs/UpdateChildAccountStatus.md

@@ -0,0 +1,12 @@
+# UpdateChildAccountStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactional_email** | **bool** | Status of Transactional Email (SMTP) Platform activation for your account (true=enabled, false=disabled) | [optional] 
+**transactional_sms** | **bool** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] 
+**marketing_automation** | **bool** | Status of Marketing Automation Platform activation for your account (true=enabled, false=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

@@ -13,7 +13,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "sib-api-v3-sdk"
-VERSION = "6.0.0"
+VERSION = "6.0.1"
 # To install the library, run the following
 #
 # python setup.py install

sib_api_v3_sdk/__init__.py

@@ -169,6 +169,7 @@
 from sib_api_v3_sdk.models.update_attribute_enumeration import UpdateAttributeEnumeration
 from sib_api_v3_sdk.models.update_campaign_status import UpdateCampaignStatus
 from sib_api_v3_sdk.models.update_child import UpdateChild
+from sib_api_v3_sdk.models.update_child_account_status import UpdateChildAccountStatus
 from sib_api_v3_sdk.models.update_child_domain import UpdateChildDomain
 from sib_api_v3_sdk.models.update_contact import UpdateContact
 from sib_api_v3_sdk.models.update_email_campaign import UpdateEmailCampaign

sib_api_v3_sdk/api/contacts_api.py

@@ -1036,7 +1036,7 @@ def get_contact_info(self, email, **kwargs):  # noqa: E501
         >>> result = thread.get()
 
         :param async bool
-        :param str email: Email (urlencoded) of the contact (required)
+        :param str email: Email (urlencoded) of the contact OR its SMS attribute value (required)
         :return: GetExtendedContactDetails
                  If the method is called asynchronously,
                  returns the request thread.
@@ -1057,7 +1057,7 @@ def get_contact_info_with_http_info(self, email, **kwargs):  # noqa: E501
         >>> result = thread.get()
 
         :param async bool
-        :param str email: Email (urlencoded) of the contact (required)
+        :param str email: Email (urlencoded) of the contact OR its SMS attribute value (required)
         :return: GetExtendedContactDetails
                  If the method is called asynchronously,
                  returns the request thread.