docs/ResellerApi.md in sib-api-v3-sdk-3.0.1 vs docs/ResellerApi.md in sib-api-v3-sdk-4.0.0

- old
+ new

@@ -2,23 +2,23 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childId}/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/{childId}/ips/associate | Associate a dedicated IP to the child +[**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/{childId} | Deletes a single reseller child based on the childId supplied -[**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childId}/ips/dissociate | Dissociate a dedicated IP to the child -[**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childId} | Gets the info about a specific child account +[**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/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account -[**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied +[**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_id, add_credits) +> RemainingCreditModel add_credits(child_auth_key, add_credits) Add Email and/or SMS credits to a specific child account ### Example ```ruby @@ -32,29 +32,29 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +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_id, add_credits) + 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_id** | **Integer**| id of reseller's child | + **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) @@ -69,11 +69,11 @@ - **Accept**: application/json # **associate_ip_to_child** -> associate_ip_to_child(child_id, ip_id) +> associate_ip_to_child(child_auth_key, ip) Associate a dedicated IP to the child ### Example ```ruby @@ -87,29 +87,29 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +child_auth_key = "child_auth_key_example" # String | auth key of reseller's child -ip_id = SibApiV3Sdk::ManageIp.new # ManageIp | IP's id +ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to associate begin #Associate a dedicated IP to the child - api_instance.associate_ip_to_child(child_id, ip_id) + 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_id** | **Integer**| id of reseller's child | - **ip_id** | [**ManageIp**](ManageIp.md)| IP's id | + **child_auth_key** | **String**| auth key of reseller's child | + **ip** | [**ManageIp**](ManageIp.md)| IP to associate | ### Return type nil (empty response body) @@ -123,11 +123,11 @@ - **Accept**: application/json # **create_reseller_child** -> CreateModel create_reseller_child(opts) +> CreateReseller create_reseller_child(opts) Creates a reseller child ### Example ```ruby @@ -162,11 +162,11 @@ ------------- | ------------- | ------------- | ------------- **reseller_child** | [**CreateChild**](CreateChild.md)| reseller child to add | [optional] ### Return type -[**CreateModel**](CreateModel.md) +[**CreateReseller**](CreateReseller.md) ### Authorization [api-key](../README.md#api-key) @@ -176,13 +176,13 @@ - **Accept**: application/json # **delete_reseller_child** -> delete_reseller_child(child_id) +> delete_reseller_child(child_auth_key) -Deletes a single reseller child based on the childId supplied +Deletes a single reseller child based on the childAuthKey supplied ### Example ```ruby # load the gem require 'sib-api-v3-sdk' @@ -194,26 +194,26 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +child_auth_key = "child_auth_key_example" # String | auth key of reseller's child begin - #Deletes a single reseller child based on the childId supplied - api_instance.delete_reseller_child(child_id) + #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_id** | **Integer**| id of reseller's child | + **child_auth_key** | **String**| auth key of reseller's child | ### Return type nil (empty response body) @@ -227,11 +227,11 @@ - **Accept**: application/json # **dissociate_ip_from_child** -> dissociate_ip_from_child(child_id, ip_id) +> dissociate_ip_from_child(child_auth_key, ip) Dissociate a dedicated IP to the child ### Example ```ruby @@ -245,29 +245,29 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +child_auth_key = "child_auth_key_example" # String | auth key of reseller's child -ip_id = SibApiV3Sdk::ManageIp.new # ManageIp | IP's id +ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to dissociate begin #Dissociate a dedicated IP to the child - api_instance.dissociate_ip_from_child(child_id, ip_id) + 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_id** | **Integer**| id of reseller's child | - **ip_id** | [**ManageIp**](ManageIp.md)| IP's id | + **child_auth_key** | **String**| auth key of reseller's child | + **ip** | [**ManageIp**](ManageIp.md)| IP to dissociate | ### Return type nil (empty response body) @@ -281,11 +281,11 @@ - **Accept**: application/json # **get_child_info** -> GetChildInfo get_child_info(child_id) +> GetChildInfo get_child_info(child_auth_key) Gets the info about a specific child account ### Example ```ruby @@ -299,27 +299,27 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +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_id) + 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_id** | **Integer**| id of reseller's child | + **child_auth_key** | **String**| auth key of reseller's child | ### Return type [**GetChildInfo**](GetChildInfo.md) @@ -379,11 +379,11 @@ - **Accept**: application/json # **remove_credits** -> RemainingCreditModel remove_credits(child_id, remove_credits) +> RemainingCreditModel remove_credits(child_auth_key, remove_credits) Remove Email and/or SMS credits from a specific child account ### Example ```ruby @@ -397,29 +397,29 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +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_id, remove_credits) + 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_id** | **Integer**| id of reseller's child | + **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) @@ -434,13 +434,13 @@ - **Accept**: application/json # **update_reseller_child** -> update_reseller_child(child_id, reseller_child) +> update_reseller_child(child_auth_key, reseller_child) -Updates infos of reseller's child based on the childId supplied +Updates infos of reseller's child based on the childAuthKey supplied ### Example ```ruby # load the gem require 'sib-api-v3-sdk' @@ -452,27 +452,27 @@ #config.api_key_prefix['api-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_id = 789 # Integer | id of reseller's child +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 childId supplied - api_instance.update_reseller_child(child_id, reseller_child) + #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_id** | **Integer**| id of reseller's child | + **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)