sib-api-v3-sdk 5.2.3 → 5.5.0

data/docs/RequestContactExport.md

@@ -4,7 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] 
-**contact_filter** | **Object** | Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts. | 
-**notify_url** | **String** | Webhook that will be called once the export process is finished | [optional] 
+**contact_filter** | **Object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts.  | [optional] 
+**custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) |  | [optional] 
+**notify_url** | **String** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 
 

data/docs/RequestContactExportCustomContactFilter.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::RequestContactExportCustomContactFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_for_contacts** | **String** | Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only.  | [optional] 
+**action_for_email_campaigns** | **String** | Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).  | [optional] 
+**action_for_sms_campaigns** | **String** | Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.  | [optional] 
+**list_id** | **Integer** | Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. | [optional] 
+**email_campaign_id** | **Integer** | Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. | [optional] 
+**sms_campaign_id** | **Integer** | Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. | [optional] 
+
+

data/docs/RequestContactImport.md

@@ -4,9 +4,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **file_url** | **String** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional] 
-**file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional] 
+**file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] 
 **list_ids** | **Array<Integer>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] 
-**notify_url** | **String** | URL that will be called once the export process is finished | [optional] 
+**notify_url** | **String** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) |  | [optional] 
 **email_blacklist** | **BOOLEAN** | To blacklist all the contacts for email | [optional] [default to false]
 **sms_blacklist** | **BOOLEAN** | To blacklist all the contacts for sms | [optional] [default to false]

data/docs/RequestSMSRecipientExport.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**notify_url** | **String** | URL that will be called once the export process is finished | [optional] 
+**notify_url** | **String** | URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 **recipients_type** | **String** | Filter the recipients based on how they interacted with the campaign | 
 
 

data/docs/ResellerApi.md

@@ -4,24 +4,26 @@ All URIs are relative to *https://api.sendinblue.com/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
-[**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
-[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account
+[**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account
+[**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child
+[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account
 [**create_reseller_child**](ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
-[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
-[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
-[**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
-[**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.
-[**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_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
+[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
+[**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied
+[**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child
+[**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
+[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account
+[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childIdentifier} | Get a child account's details
+[**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts
+[**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Sendinblue (SSO)
+[**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childIdentifier}/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/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied
+[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed
+[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied
 
 
 # **add_credits**
-> RemainingCreditModel add_credits(child_auth_key, add_credits)
+> RemainingCreditModel add_credits(child_identifier, add_credits)
 
 Add Email and/or SMS credits to a specific child account
 
@@ -44,14 +46,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 add_credits = SibApiV3Sdk::AddCredits.new # AddCredits | Values to post to add credit to a specific child account
 
 
 begin
   #Add Email and/or SMS credits to a specific child account
-  result = api_instance.add_credits(child_auth_key, add_credits)
+  result = api_instance.add_credits(child_identifier, add_credits)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->add_credits: #{e}"
@@ -62,7 +64,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **add_credits** | [**AddCredits**](AddCredits.md)| Values to post to add credit to a specific child account | 
 
 ### Return type
@@ -81,7 +83,7 @@ Name | Type | Description  | Notes
 
 
 # **associate_ip_to_child**
-> associate_ip_to_child(child_auth_key, ip)
+> associate_ip_to_child(child_identifier, ip)
 
 Associate a dedicated IP to the child
 
@@ -104,14 +106,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to associate
 
 
 begin
   #Associate a dedicated IP to the child
-  api_instance.associate_ip_to_child(child_auth_key, ip)
+  api_instance.associate_ip_to_child(child_identifier, ip)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->associate_ip_to_child: #{e}"
 end
@@ -121,7 +123,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **ip** | [**ManageIp**](ManageIp.md)| IP to associate | 
 
 ### Return type
@@ -140,9 +142,9 @@ nil (empty response body)
 
 
 # **create_child_domain**
-> create_child_domain(child_auth_key, add_child_domain)
+> create_child_domain(child_identifier, add_child_domain)
 
-Creates a domain for a child account
+Create a domain for a child account
 
 ### Example
 ```ruby
@@ -163,14 +165,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
-add_child_domain = SibApiV3Sdk::AddChildDomain.new # AddChildDomain | Sender domain to add for a specific child account
+add_child_domain = SibApiV3Sdk::AddChildDomain.new # AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.
 
 
 begin
-  #Creates a domain for a child account
-  api_instance.create_child_domain(child_auth_key, add_child_domain)
+  #Create a domain for a child account
+  api_instance.create_child_domain(child_identifier, add_child_domain)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->create_child_domain: #{e}"
 end
@@ -180,8 +182,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
- **add_child_domain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
+ **add_child_domain** | [**AddChildDomain**](AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. | 
 
 ### Return type
 
@@ -257,9 +259,9 @@ Name | Type | Description  | Notes
 
 
 # **delete_child_domain**
-> delete_child_domain(child_auth_key, domain_name)
+> delete_child_domain(child_identifier, domain_name)
 
-Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
+Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
 
 ### Example
 ```ruby
@@ -280,14 +282,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
-domain_name = "domain_name_example" # String | Pass the existing domain that needs to be deleted
+domain_name = 'domain_name_example' # String | Pass the existing domain that needs to be deleted
 
 
 begin
-  #Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
-  api_instance.delete_child_domain(child_auth_key, domain_name)
+  #Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
+  api_instance.delete_child_domain(child_identifier, domain_name)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->delete_child_domain: #{e}"
 end
@@ -297,7 +299,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **domain_name** | **String**| Pass the existing domain that needs to be deleted | 
 
 ### Return type
@@ -316,9 +318,9 @@ nil (empty response body)
 
 
 # **delete_reseller_child**
-> delete_reseller_child(child_auth_key)
+> delete_reseller_child(child_identifier)
 
-Deletes a single reseller child based on the childAuthKey supplied
+Delete a single reseller child based on the child identifier supplied
 
 ### Example
 ```ruby
@@ -339,12 +341,12 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or child id of reseller's child
 
 
 begin
-  #Deletes a single reseller child based on the childAuthKey supplied
-  api_instance.delete_reseller_child(child_auth_key)
+  #Delete a single reseller child based on the child identifier supplied
+  api_instance.delete_reseller_child(child_identifier)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->delete_reseller_child: #{e}"
 end
@@ -354,7 +356,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or child id of reseller's child | 
 
 ### Return type
 
@@ -372,7 +374,7 @@ nil (empty response body)
 
 
 # **dissociate_ip_from_child**
-> dissociate_ip_from_child(child_auth_key, ip)
+> dissociate_ip_from_child(child_identifier, ip)
 
 Dissociate a dedicated IP to the child
 
@@ -395,14 +397,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to dissociate
 
 
 begin
   #Dissociate a dedicated IP to the child
-  api_instance.dissociate_ip_from_child(child_auth_key, ip)
+  api_instance.dissociate_ip_from_child(child_identifier, ip)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->dissociate_ip_from_child: #{e}"
 end
@@ -412,7 +414,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **ip** | [**ManageIp**](ManageIp.md)| IP to dissociate | 
 
 ### Return type
@@ -430,10 +432,67 @@ nil (empty response body)
 
 
 
+# **get_child_account_creation_status**
+> GetChildAccountCreationStatus get_child_account_creation_status(child_identifier)
+
+Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::ResellerApi.new
+
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
+
+
+begin
+  #Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied
+  result = api_instance.get_child_account_creation_status(child_identifier)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->get_child_account_creation_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
+
+### Return type
+
+[**GetChildAccountCreationStatus**](GetChildAccountCreationStatus.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_child_domains**
-> GetChildDomains get_child_domains(child_auth_key)
+> GetChildDomains get_child_domains(child_identifier)
 
-Gets all the sender domains of a specific child account
+Get all sender domains for a specific child account
 
 ### Example
 ```ruby
@@ -454,12 +513,12 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 
 begin
-  #Gets all the sender domains of a specific child account
-  result = api_instance.get_child_domains(child_auth_key)
+  #Get all sender domains for a specific child account
+  result = api_instance.get_child_domains(child_identifier)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->get_child_domains: #{e}"
@@ -470,7 +529,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
 
 ### Return type
 
@@ -488,9 +547,9 @@ Name | Type | Description  | Notes
 
 
 # **get_child_info**
-> GetChildInfo get_child_info(child_auth_key)
+> GetChildInfo get_child_info(child_identifier)
 
-Gets the info about a specific child account
+Get a child account's details
 
 ### Example
 ```ruby
@@ -511,12 +570,12 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 
 begin
-  #Gets the info about a specific child account
-  result = api_instance.get_child_info(child_auth_key)
+  #Get a child account's details
+  result = api_instance.get_child_info(child_identifier)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->get_child_info: #{e}"
@@ -527,7 +586,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
 
 ### Return type
 
@@ -545,9 +604,9 @@ Name | Type | Description  | Notes
 
 
 # **get_reseller_childs**
-> GetChildrenList get_reseller_childs
+> GetChildrenList get_reseller_childs(opts)
 
-Gets the list of all reseller's children accounts
+Get the list of all children accounts
 
 ### Example
 ```ruby
@@ -568,9 +627,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
+opts = { 
+  limit: 10, # Integer | Number of documents for child accounts information per page
+  offset: 0 # Integer | Index of the first document in the page
+}
+
 begin
-  #Gets the list of all reseller's children accounts
-  result = api_instance.get_reseller_childs
+  #Get the list of all children accounts
+  result = api_instance.get_reseller_childs(opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->get_reseller_childs: #{e}"
@@ -578,7 +642,11 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of documents for child accounts information per page | [optional] [default to 10]
+ **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
 
 ### Return type
 
@@ -596,9 +664,11 @@ This endpoint does not need any parameter.
 
 
 # **get_sso_token**
-> GetSsoToken get_sso_token(child_auth_key)
+> GetSsoToken get_sso_token(child_identifier)
 
-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
 ```ruby
@@ -619,12 +689,12 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 
 begin
-  #Generates a session token which will remain valid for a short period of time only.
-  result = api_instance.get_sso_token(child_auth_key)
+  #Get session token to access Sendinblue (SSO)
+  result = api_instance.get_sso_token(child_identifier)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->get_sso_token: #{e}"
@@ -635,7 +705,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
 
 ### Return type
 
@@ -653,7 +723,7 @@ Name | Type | Description  | Notes
 
 
 # **remove_credits**
-> RemainingCreditModel remove_credits(child_auth_key, remove_credits)
+> RemainingCreditModel remove_credits(child_identifier, remove_credits)
 
 Remove Email and/or SMS credits from a specific child account
 
@@ -676,14 +746,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 remove_credits = SibApiV3Sdk::RemoveCredits.new # RemoveCredits | Values to post to remove email or SMS credits from a specific child account
 
 
 begin
   #Remove Email and/or SMS credits from a specific child account
-  result = api_instance.remove_credits(child_auth_key, remove_credits)
+  result = api_instance.remove_credits(child_identifier, remove_credits)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->remove_credits: #{e}"
@@ -694,7 +764,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **remove_credits** | [**RemoveCredits**](RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account | 
 
 ### Return type
@@ -712,10 +782,69 @@ Name | Type | Description  | Notes
 
 
 
+# **update_child_account_status**
+> update_child_account_status(child_identifier, update_child_account_status)
+
+Update info of reseller's child account status based on the childIdentifier supplied
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::ResellerApi.new
+
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
+
+update_child_account_status = SibApiV3Sdk::UpdateChildAccountStatus.new # UpdateChildAccountStatus | values to update in child account status
+
+
+begin
+  #Update info of reseller's child account status based on the childIdentifier supplied
+  api_instance.update_child_account_status(child_identifier, update_child_account_status)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->update_child_account_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
+ **update_child_account_status** | [**UpdateChildAccountStatus**](UpdateChildAccountStatus.md)| values to update in child account status | 
+
+### Return type
+
+nil (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
+
+
+
 # **update_child_domain**
-> update_child_domain(child_auth_key, domain_name, update_child_domain)
+> update_child_domain(child_identifier, domain_name, update_child_domain)
 
-Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
+Update the sender domain of reseller's child based on the childIdentifier and domainName passed
 
 ### Example
 ```ruby
@@ -736,16 +865,16 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
-domain_name = "domain_name_example" # String | Pass the existing domain that needs to be updated
+domain_name = 'domain_name_example' # String | Pass the existing domain that needs to be updated
 
 update_child_domain = SibApiV3Sdk::UpdateChildDomain.new # UpdateChildDomain | value to update for sender domain
 
 
 begin
-  #Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
-  api_instance.update_child_domain(child_auth_key, domain_name, update_child_domain)
+  #Update the sender domain of reseller's child based on the childIdentifier and domainName passed
+  api_instance.update_child_domain(child_identifier, domain_name, update_child_domain)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->update_child_domain: #{e}"
 end
@@ -755,7 +884,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **domain_name** | **String**| Pass the existing domain that needs to be updated | 
  **update_child_domain** | [**UpdateChildDomain**](UpdateChildDomain.md)| value to update for sender domain | 
 
@@ -775,9 +904,9 @@ nil (empty response body)
 
 
 # **update_reseller_child**
-> update_reseller_child(child_auth_key, reseller_child)
+> update_reseller_child(child_identifier, reseller_child)
 
-Updates infos of reseller's child based on the childAuthKey supplied
+Update info of reseller's child based on the child identifier supplied
 
 ### Example
 ```ruby
@@ -798,14 +927,14 @@ end
 
 api_instance = SibApiV3Sdk::ResellerApi.new
 
-child_auth_key = "child_auth_key_example" # String | auth key of reseller's child
+child_identifier = 'child_identifier_example' # String | Either auth key or id of reseller's child
 
 reseller_child = SibApiV3Sdk::UpdateChild.new # UpdateChild | values to update in child profile
 
 
 begin
-  #Updates infos of reseller's child based on the childAuthKey supplied
-  api_instance.update_reseller_child(child_auth_key, reseller_child)
+  #Update info of reseller's child based on the child identifier supplied
+  api_instance.update_reseller_child(child_identifier, reseller_child)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ResellerApi->update_reseller_child: #{e}"
 end
@@ -815,7 +944,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **child_auth_key** | **String**| auth key of reseller's child | 
+ **child_identifier** | **String**| Either auth key or id of reseller's child | 
  **reseller_child** | [**UpdateChild**](UpdateChild.md)| values to update in child profile | 
 
 ### Return type