SibApiV3Sdk::ResellerApi

All URIs are relative to https://api.sendinblue.com/v3

Method	HTTP request	Description
add_credits	POST /reseller/children/{childAuthKey}/credits/add	Add Email and/or SMS credits to a specific child account
associate_ip_to_child	POST /reseller/children/{childAuthKey}/ips/associate	Associate a dedicated IP to the child
create_reseller_child	POST /reseller/children	Creates a reseller child
delete_reseller_child	DELETE /reseller/children/{childAuthKey}	Deletes a single reseller child based on the childAuthKey supplied
dissociate_ip_from_child	POST /reseller/children/{childAuthKey}/ips/dissociate	Dissociate a dedicated IP to the child
get_child_info	GET /reseller/children/{childAuthKey}	Gets the info about a specific child account
get_reseller_childs	GET /reseller/children	Gets the list of all reseller's children accounts
remove_credits	POST /reseller/children/{childAuthKey}/credits/remove	Remove Email and/or SMS credits from a specific child account
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

# 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	Values to post to add credit to a specific child account

Return type

RemainingCreditModel

Authorization

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

# 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	IP to associate

Return type

nil (empty response body)

Authorization

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

# 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	reseller child to add	[optional]

Return type

CreateReseller

Authorization

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

# 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

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

# 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	IP to dissociate

Return type

nil (empty response body)

Authorization

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

# 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

Authorization

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

# 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

Authorization

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

# 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	Values to post to remove email or SMS credits from a specific child account

Return type

RemainingCreditModel

Authorization

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

# 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	values to update in child profile

Return type

nil (empty response body)

Authorization

api-key

HTTP request headers

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

FilesExpand file tree

ResellerApi.md

Latest commit

History

ResellerApi.md

File metadata and controls

SibApiV3Sdk::ResellerApi

add_credits

Example

Parameters

Return type

Authorization

HTTP request headers

associate_ip_to_child

Example

Parameters

Return type

Authorization

HTTP request headers

create_reseller_child

Example

Parameters

Return type

Authorization

HTTP request headers

delete_reseller_child

Example

Parameters

Return type

Authorization

HTTP request headers

dissociate_ip_from_child

Example

Parameters

Return type

Authorization

HTTP request headers

get_child_info

Example

Parameters

Return type

Authorization

HTTP request headers

get_reseller_childs

Example

Parameters

Return type

Authorization

HTTP request headers

remove_credits

Example

Parameters

Return type

Authorization

HTTP request headers

update_reseller_child

Example

Parameters

Return type

Authorization

HTTP request headers