docs/ResellerApi.md in sib-api-v3-sdk-5.3.0 vs docs/ResellerApi.md in sib-api-v3-sdk-5.4.0
- old
+ new
@@ -4,24 +4,24 @@
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
+[**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/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
+[**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete 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} | Delete 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_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
-[**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_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
+[**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account
+[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | 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/{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
+[**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info 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} | Update 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} | Update info of reseller's child based on the childAuthKey supplied
# **add_credits**
> RemainingCreditModel add_credits(child_auth_key, add_credits)
@@ -142,11 +142,11 @@
# **create_child_domain**
> create_child_domain(child_auth_key, add_child_domain)
-Creates a domain for a child account
+Create a domain for a child account
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -169,11 +169,11 @@
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
+ #Create a domain for a child account
api_instance.create_child_domain(child_auth_key, add_child_domain)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->create_child_domain: #{e}"
end
```
@@ -259,11 +259,11 @@
# **delete_child_domain**
> delete_child_domain(child_auth_key, 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 childAuthKey and domainName passed
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -286,11 +286,11 @@
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
+ #Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
api_instance.delete_child_domain(child_auth_key, domain_name)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->delete_child_domain: #{e}"
end
```
@@ -318,11 +318,11 @@
# **delete_reseller_child**
> delete_reseller_child(child_auth_key)
-Deletes a single reseller child based on the childAuthKey supplied
+Delete a single reseller child based on the childAuthKey supplied
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -343,11 +343,11 @@
child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
begin
- #Deletes a single reseller child based on the childAuthKey supplied
+ #Delete a single reseller child based on the childAuthKey supplied
api_instance.delete_reseller_child(child_auth_key)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->delete_reseller_child: #{e}"
end
```
@@ -433,11 +433,11 @@
# **get_child_account_creation_status**
> GetChildAccountCreationStatus get_child_account_creation_status(child_auth_key)
-Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
+Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -458,11 +458,11 @@
child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
begin
- #Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
+ #Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
result = api_instance.get_child_account_creation_status(child_auth_key)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->get_child_account_creation_status: #{e}"
end
@@ -490,11 +490,11 @@
# **get_child_domains**
> GetChildDomains get_child_domains(child_auth_key)
-Gets all the sender domains of a specific child account
+Get all sender domains for a specific child account
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -515,11 +515,11 @@
child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
begin
- #Gets all the sender domains of a specific child account
+ #Get all sender domains for a specific child account
result = api_instance.get_child_domains(child_auth_key)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->get_child_domains: #{e}"
end
@@ -547,11 +547,11 @@
# **get_child_info**
> GetChildInfo get_child_info(child_auth_key)
-Gets the info about a specific child account
+Get a child account's details
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -572,11 +572,11 @@
child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child
begin
- #Gets the info about a specific child account
+ #Get a child account's details
result = api_instance.get_child_info(child_auth_key)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->get_child_info: #{e}"
end
@@ -604,11 +604,11 @@
# **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
# load the gem
require 'sib-api-v3-sdk'
@@ -631,11 +631,11 @@
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
+ #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}"
end
@@ -783,11 +783,11 @@
# **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
+Update info of reseller's child account status based on the childAuthKey supplied
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -810,11 +810,11 @@
update_child_account_status = SibApiV3Sdk::UpdateChildAccountStatus.new # UpdateChildAccountStatus | values to update in child account status
begin
- #Updates infos of reseller's child account status based on the childAuthKey supplied
+ #Update info of reseller's child account status based on the childAuthKey supplied
api_instance.update_child_account_status(child_auth_key, update_child_account_status)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->update_child_account_status: #{e}"
end
```
@@ -842,11 +842,11 @@
# **update_child_domain**
> update_child_domain(child_auth_key, 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 childAuthKey and domainName passed
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -871,11 +871,11 @@
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
+ #Update 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)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->update_child_domain: #{e}"
end
```
@@ -904,11 +904,11 @@
# **update_reseller_child**
> update_reseller_child(child_auth_key, reseller_child)
-Updates infos of reseller's child based on the childAuthKey supplied
+Update info of reseller's child based on the childAuthKey supplied
### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
@@ -931,10 +931,10 @@
reseller_child = SibApiV3Sdk::UpdateChild.new # UpdateChild | values to update in child profile
begin
- #Updates infos of reseller's child based on the childAuthKey supplied
+ #Update info of reseller's child based on the childAuthKey supplied
api_instance.update_reseller_child(child_auth_key, reseller_child)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ResellerApi->update_reseller_child: #{e}"
end
```