docs/ResellerApi.md in sib-api-v3-sdk-5.2.5 vs docs/ResellerApi.md in sib-api-v3-sdk-5.3.0

- old
+ new

@@ -9,10 +9,11 @@ [**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates 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_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_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 @@ -43,11 +44,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key 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 @@ -103,11 +104,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to associate begin @@ -162,13 +163,13 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key 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) @@ -180,11 +181,11 @@ ### Parameters 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 | + **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 nil (empty response body) @@ -279,13 +280,13 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key 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) @@ -338,11 +339,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key 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 childAuthKey supplied api_instance.delete_reseller_child(child_auth_key) @@ -394,11 +395,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child ip = SibApiV3Sdk::ManageIp.new # ManageIp | IP to dissociate begin @@ -429,10 +430,67 @@ - **Content-Type**: application/json - **Accept**: application/json +# **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 + +### 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_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 + 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 +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **child_auth_key** | **String**| auth key 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) Gets all the sender domains of a specific child account @@ -453,11 +511,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +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 result = api_instance.get_child_domains(child_auth_key) @@ -510,11 +568,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key 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_auth_key) @@ -544,11 +602,11 @@ - **Accept**: application/json # **get_reseller_childs** -> GetChildrenList get_reseller_childs +> GetChildrenList get_reseller_childs(opts) Gets the list of all reseller's children accounts ### Example ```ruby @@ -567,22 +625,31 @@ #config.api_key_prefix['partner-key'] = 'Bearer' 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 + result = api_instance.get_reseller_childs(opts) p result rescue SibApiV3Sdk::ApiError => e puts "Exception when calling ResellerApi->get_reseller_childs: #{e}" 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 [**GetChildrenList**](GetChildrenList.md) ### Authorization @@ -620,11 +687,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child begin #Get session token to access Sendinblue (SSO) result = api_instance.get_sso_token(child_auth_key) @@ -677,11 +744,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key 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 @@ -737,11 +804,11 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key of reseller's child update_child_account_status = SibApiV3Sdk::UpdateChildAccountStatus.new # UpdateChildAccountStatus | values to update in child account status begin @@ -796,13 +863,13 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key of reseller's child +child_auth_key = 'child_auth_key_example' # String | auth key 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 @@ -858,10 +925,10 @@ #config.api_key_prefix['partner-key'] = 'Bearer' end api_instance = SibApiV3Sdk::ResellerApi.new -child_auth_key = "child_auth_key_example" # String | auth key 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