sib-api-v3-sdk 1.0.0

data/docs/ManageIp.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::ManageIp
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip_id** | **Integer** | ID of the IP | [optional] 
+
+

data/docs/PostContactInfo.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::PostContactInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contacts** | [**PostContactInfoContacts**](PostContactInfoContacts.md) |  | [optional] 
+
+

data/docs/PostContactInfoContacts.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::PostContactInfoContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Array<String>** |  | 
+**failure** | **Array<String>** |  | [optional] 
+
+

data/docs/PostSendFailed.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::PostSendFailed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response code | 
+**message** | **String** | Response message | 
+**unexisting_emails** | **Array<String>** |  | [optional] 
+**without_list_emails** | **Array<String>** |  | [optional] 
+**black_listed_emails** | **Array<String>** |  | [optional] 
+
+

data/docs/PostSendSmsTestFailed.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::PostSendSmsTestFailed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Response code | 
+**message** | **String** | Response message | 
+**unexisting_sms** | **Array<String>** |  | [optional] 
+**without_list_sms** | **Array<String>** |  | [optional] 
+
+

data/docs/ProcessApi.md

@@ -0,0 +1,117 @@
+# SibApiV3Sdk::ProcessApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_process**](ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
+[**get_processes**](ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
+
+
+# **get_process**
+> GetProcess get_process(process_id)
+
+Return the informations for a process
+
+### 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::ProcessApi.new
+
+process_id = "process_id_example" # String | Id of the process
+
+
+begin
+  #Return the informations for a process
+  result = api_instance.get_process(process_id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ProcessApi->get_process: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **process_id** | **String**| Id of the process | 
+
+### Return type
+
+[**GetProcess**](GetProcess.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_processes**
+> GetProcesses get_processes(opts)
+
+Return all the processes for your 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::ProcessApi.new
+
+opts = { 
+  limit: 10, # Integer | Number limitation for the result returned
+  offset: 0 # Integer | Beginning point in the list to retrieve from.
+}
+
+begin
+  #Return all the processes for your account
+  result = api_instance.get_processes(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ProcessApi->get_processes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 10]
+ **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
+
+### Return type
+
+[**GetProcesses**](GetProcesses.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/RemainingCreditModel.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RemainingCreditModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**child** | [**RemainingCreditModelChild**](RemainingCreditModelChild.md) |  | [optional] 
+**reseller** | [**RemainingCreditModelReseller**](RemainingCreditModelReseller.md) |  | [optional] 
+
+

data/docs/RemainingCreditModelChild.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RemainingCreditModelChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Integer** | SMS Credits remaining for child account | 
+**email** | **Integer** | Email Credits remaining for child account | 
+
+

data/docs/RemainingCreditModelReseller.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RemainingCreditModelReseller
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Integer** | SMS Credits remaining for reseller account | 
+**email** | **Integer** | Email Credits remaining for reseller account | 
+
+

data/docs/RemoveCredits.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RemoveCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Integer** | SMS credits to be removed from the child account | [optional] 
+**email** | **Integer** | Email credits to be removed from the child account | [optional] 
+
+

data/docs/RequestContactExport.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::RequestContactExport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**export_attributes** | **Array<String>** | Name of attributes to export. These attributes must be in your contact database | [optional] 
+**contact_filter** | **Object** | Filter to apply to the export | 
+**notify_url** | **String** | Webhook that will be called once the export process is finished | [optional] 
+
+

data/docs/RequestContactImport.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::RequestContactImport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_url** | **String** | Mandatory if fileBody not defined. URL of the file to be imported (no local file). Possible file types: .txt, .csv | [optional] 
+**file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional] 
+**list_ids** | **Array<Integer>** | Manadatory if newList is not defined. Ids of the lists in which to add the contacts | [optional] 
+**notify_url** | **String** | URL that will be called once the export process is finished | [optional] 
+**new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) |  | [optional] 
+
+

data/docs/RequestContactImportNewList.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RequestContactImportNewList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list_name** | **String** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] 
+**folder_id** | **Integer** | Folder id will be used with listName to make newly created list’s desired parent (Mandatory if listName is not empty). | [optional] 
+
+

data/docs/RequestSMSRecipientExport.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RequestSMSRecipientExport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notify_url** | **String** | URL that will be called once the export process is finished | [optional] 
+**recipients_type** | **String** | Filter the recipients based on how they interacted with the campaign | [default to "all"]
+
+

data/docs/ResellerApi.md

@@ -0,0 +1,491 @@
+# 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/{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
+[**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
+[**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
+
+
+# **add_credits**
+> RemainingCreditModel add_credits(child_id, 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_id = 56 # Integer | id 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)
+  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 | 
+ **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_id, ip_id)
+
+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_id = 56 # Integer | id of reseller's child
+
+ip_id = SibApiV3Sdk::ManageIp.new # ManageIp | IP's id
+
+
+begin
+  #Associate a dedicated IP to the child
+  api_instance.associate_ip_to_child(child_id, ip_id)
+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 | 
+
+### 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**
+> CreateModel 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
+
+[**CreateModel**](CreateModel.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_id)
+
+Deletes a single reseller child based on the childId 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_id = 56 # Integer | id of reseller's child
+
+
+begin
+  #Deletes a single reseller child based on the childId supplied
+  api_instance.delete_reseller_child(child_id)
+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 | 
+
+### 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_id, ip_id)
+
+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_id = 56 # Integer | id of reseller's child
+
+ip_id = SibApiV3Sdk::ManageIp.new # ManageIp | IP's id
+
+
+begin
+  #Dissociate a dedicated IP to the child
+  api_instance.dissociate_ip_from_child(child_id, ip_id)
+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 | 
+
+### 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_id)
+
+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_id = 56 # Integer | id of reseller's child
+
+
+begin
+  #Gets the info about a specific child account
+  result = api_instance.get_child_info(child_id)
+  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 | 
+
+### 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_id, 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_id = 56 # Integer | id 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)
+  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 | 
+ **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_id, reseller_child)
+
+Updates infos of reseller's child based on the childId 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_id = 56 # Integer | id 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)
+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 | 
+ **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
+
+
+