sib-api-v3-sdk 5.2.2 → 5.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4ff8d75ee2a788e04419e8b01331c4e963d6f6636ed1573c36de48cf502881
-  data.tar.gz: 358d03549ce436aadb920ce4966bc2531f40598800808ce60d478e9465d35784
+  metadata.gz: 4bdbd89d3528035d522222b11370235476da620a375b5e0144fe436620d7eb3a
+  data.tar.gz: e6f8148806c8777a2815a1ef52f98e895194c2ea9576e7501ab84851a9a3abd5
 SHA512:
-  metadata.gz: 2949262efe9d3810942d47c677af7222463dba547d5c422eacefc63e716f6eca6d4651ec9ef33e4b22adaf563a7adb7a60155b2b93a374a24d34d40f19f7c355
-  data.tar.gz: 97d5b4ecd19e0efee43bc248270d2385741ba06a94c31c3b1ce933e5ffc896e3d55cfd589456df37169ebd29002fabef6744cb7882e075d56f2bbb709789bc70
+  metadata.gz: f2e58a137ae24166e844c8dd3388ce36ba0f0b1820d7cd6a39678bb013ba8ad15dc3fc50411fb2dd32140cc89c06f435a3e0b8a191a03e0d5a9856b2ddc19113
+  data.tar.gz: 0d605598df8619303be750f7373d8e625416cdc2a3746b429808c02cbee57171a32ab3cebbaa8754ae189221a1856ab9054a15801491d3375a4b522a3affc9d6

data/README.md

@@ -59,6 +59,11 @@ SibApiV3Sdk.configure do |config|
   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::AccountApi.new
@@ -139,12 +144,17 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
 *SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
 *SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
+*SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account
 *SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
+*SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/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
 *SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
 *SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
+*SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
 *SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
 *SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
+*SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Generates a session token which will remain valid for a short period of time only.
 *SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
+*SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
 *SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
 *SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
 *SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
@@ -187,6 +197,7 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
  - [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
  - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
@@ -225,6 +236,8 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
  - [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
  - [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
+ - [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
+ - [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
  - [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
  - [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
  - [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
@@ -278,6 +291,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::GetSmtpTemplateOverview](docs/GetSmtpTemplateOverview.md)
  - [SibApiV3Sdk::GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
  - [SibApiV3Sdk::GetSmtpTemplates](docs/GetSmtpTemplates.md)
+ - [SibApiV3Sdk::GetSsoToken](docs/GetSsoToken.md)
  - [SibApiV3Sdk::GetStatsByDomain](docs/GetStatsByDomain.md)
  - [SibApiV3Sdk::GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
  - [SibApiV3Sdk::GetTransacSmsReport](docs/GetTransacSmsReport.md)
@@ -318,6 +332,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
  - [SibApiV3Sdk::UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
  - [SibApiV3Sdk::UpdateChild](docs/UpdateChild.md)
+ - [SibApiV3Sdk::UpdateChildDomain](docs/UpdateChildDomain.md)
  - [SibApiV3Sdk::UpdateContact](docs/UpdateContact.md)
  - [SibApiV3Sdk::UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
  - [SibApiV3Sdk::UpdateEmailCampaignRecipients](docs/UpdateEmailCampaignRecipients.md)
@@ -347,6 +362,12 @@ Class | Method | HTTP request | Description
 - **API key parameter name**: api-key
 - **Location**: HTTP header
 
+### partner-key
+
+- **Type**: API key
+- **API key parameter name**: partner-key
+- **Location**: HTTP header
+
 
 ## Support and Feedback
 

data/docs/AddChildDomain.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::AddChildDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **String** | Sender domain to add for a specific child account | [optional] 
+
+

data/docs/GetChildDomain.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetChildDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **String** | Sender domain | 
+**active** | **BOOLEAN** | indicates whether a domain is verified or not | 
+
+

data/docs/GetChildDomains.md

@@ -0,0 +1,7 @@
+# SibApiV3Sdk::GetChildDomains
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/GetSsoToken.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetSsoToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** | Session token. It will remain valid for a short period of time only. | 
+
+

data/docs/ResellerApi.md

@@ -6,12 +6,17 @@ 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_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_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 | Generates a session token which will remain valid for a short period of time only.
 [**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
+[**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
 [**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
 
 
@@ -134,6 +139,65 @@ nil (empty response body)
 
 
 
+# **create_child_domain**
+> create_child_domain(child_auth_key, add_child_domain)
+
+Creates a domain for a 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'
+
+  # 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
+
+add_child_domain = SibApiV3Sdk::AddChildDomain.new # AddChildDomain | Sender domain to add for a specific child account
+
+
+begin
+  #Creates a domain for a child account
+  api_instance.create_child_domain(child_auth_key, add_child_domain)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->create_child_domain: #{e}"
+end
+```
+
+### 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 | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **create_reseller_child**
 > CreateReseller create_reseller_child(opts)
 
@@ -192,6 +256,65 @@ Name | Type | Description  | Notes
 
 
 
+# **delete_child_domain**
+> delete_child_domain(child_auth_key, domain_name)
+
+Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
+
+### 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
+
+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)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->delete_child_domain: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_auth_key** | **String**| auth key of reseller's child | 
+ **domain_name** | **String**| Pass the existing domain that needs to be deleted | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_reseller_child**
 > delete_reseller_child(child_auth_key)
 
@@ -307,6 +430,63 @@ nil (empty response body)
 
 
 
+# **get_child_domains**
+> GetChildDomains get_child_domains(child_auth_key)
+
+Gets all the sender domains of 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'
+
+  # 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
+  #Gets all the sender domains of a specific child account
+  result = api_instance.get_child_domains(child_auth_key)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->get_child_domains: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_auth_key** | **String**| auth key of reseller's child | 
+
+### Return type
+
+[**GetChildDomains**](GetChildDomains.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_info**
 > GetChildInfo get_child_info(child_auth_key)
 
@@ -415,6 +595,63 @@ This endpoint does not need any parameter.
 
 
 
+# **get_sso_token**
+> GetSsoToken get_sso_token(child_auth_key)
+
+Generates a session token which will remain valid for a short period of time only.
+
+### 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
+  #Generates a session token which will remain valid for a short period of time only.
+  result = api_instance.get_sso_token(child_auth_key)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->get_sso_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_auth_key** | **String**| auth key of reseller's child | 
+
+### Return type
+
+[**GetSsoToken**](GetSsoToken.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **remove_credits**
 > RemainingCreditModel remove_credits(child_auth_key, remove_credits)
 
@@ -475,6 +712,68 @@ Name | Type | Description  | Notes
 
 
 
+# **update_child_domain**
+> update_child_domain(child_auth_key, domain_name, update_child_domain)
+
+Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
+
+### 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
+
+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
+  #Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
+  api_instance.update_child_domain(child_auth_key, domain_name, update_child_domain)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ResellerApi->update_child_domain: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **child_auth_key** | **String**| auth key of reseller's child | 
+ **domain_name** | **String**| Pass the existing domain that needs to be updated | 
+ **update_child_domain** | [**UpdateChildDomain**](UpdateChildDomain.md)| value to update for sender domain | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_reseller_child**
 > update_reseller_child(child_auth_key, reseller_child)