# SibApiV3Sdk::ResellerApi

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_reseller_child**](ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
[**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_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
[**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied


# **add_credits**
> RemainingCreditModel add_credits(child_auth_key, add_credits)

Add Email and/or SMS credits to a specific child account

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

child_auth_key = "child_auth_key_example" # String | auth key 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)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->add_credits: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key of reseller's child | 
 **add_credits** | [**AddCredits**](AddCredits.md)| Values to post to add credit to a specific child account | 

### Return type

[**RemainingCreditModel**](RemainingCreditModel.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **associate_ip_to_child**
> associate_ip_to_child(child_auth_key, ip)

Associate a dedicated IP to the child

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

child_auth_key = "child_auth_key_example" # String | auth key 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)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->associate_ip_to_child: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key of reseller's child | 
 **ip** | [**ManageIp**](ManageIp.md)| IP to associate | 

### Return type

nil (empty response body)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **create_reseller_child**
> CreateReseller create_reseller_child(opts)

Creates a reseller child

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

opts = { 
  reseller_child: SibApiV3Sdk::CreateChild.new # CreateChild | reseller child to add
}

begin
  #Creates a reseller child
  result = api_instance.create_reseller_child(opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->create_reseller_child: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **reseller_child** | [**CreateChild**](CreateChild.md)| reseller child to add | [optional] 

### Return type

[**CreateReseller**](CreateReseller.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **delete_reseller_child**
> delete_reseller_child(child_auth_key)

Deletes a single reseller child based on the childAuthKey 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

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
  api_instance.delete_reseller_child(child_auth_key)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->delete_reseller_child: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key of reseller's child | 

### Return type

nil (empty response body)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **dissociate_ip_from_child**
> dissociate_ip_from_child(child_auth_key, ip)

Dissociate a dedicated IP to the child

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

child_auth_key = "child_auth_key_example" # String | auth key 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)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->dissociate_ip_from_child: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key of reseller's child | 
 **ip** | [**ManageIp**](ManageIp.md)| IP to dissociate | 

### Return type

nil (empty response body)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **get_child_info**
> GetChildInfo get_child_info(child_auth_key)

Gets the info about a specific child account

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

child_auth_key = "child_auth_key_example" # String | auth key of reseller's child


begin
  #Gets the info about a specific child account
  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
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key of reseller's child | 

### Return type

[**GetChildInfo**](GetChildInfo.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **get_reseller_childs**
> GetChildrenList get_reseller_childs

Gets the list of all reseller's children accounts

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

begin
  #Gets the list of all reseller's children accounts
  result = api_instance.get_reseller_childs
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->get_reseller_childs: #{e}"
end
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**GetChildrenList**](GetChildrenList.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **remove_credits**
> RemainingCreditModel remove_credits(child_auth_key, remove_credits)

Remove Email and/or SMS credits from a specific child account

### 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

child_auth_key = "child_auth_key_example" # String | auth key 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)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->remove_credits: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key 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

[**RemainingCreditModel**](RemainingCreditModel.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



# **update_reseller_child**
> update_reseller_child(child_auth_key, reseller_child)

Updates infos of reseller's child based on the childAuthKey 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'
end

api_instance = SibApiV3Sdk::ResellerApi.new

child_auth_key = "child_auth_key_example" # String | auth key 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)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ResellerApi->update_reseller_child: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **child_auth_key** | **String**| auth key of reseller's child | 
 **reseller_child** | [**UpdateChild**](UpdateChild.md)| values to update in child profile | 

### Return type

nil (empty response body)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json