LanguagesApi.html.md in purecloud-0.56.1

- old
+ new

@@ -9,10 +9,14 @@
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 |[**delete_language_id**](LanguagesApi.html#delete_language_id) | **DELETE** /api/v2/languages/{languageId} | Delete Language|
 |[**get_language_id**](LanguagesApi.html#get_language_id) | **GET** /api/v2/languages/{languageId} | Get language|
 |[**get_languages**](LanguagesApi.html#get_languages) | **GET** /api/v2/languages | Get the list of supported languages.|
+|[**get_translations**](LanguagesApi.html#get_translations) | **GET** /api/v2/languages/translations | Get all available languages for translation|
+|[**get_translations_builtin**](LanguagesApi.html#get_translations_builtin) | **GET** /api/v2/languages/translations/builtin | Get the builtin translation for a language|
+|[**get_translations_organization**](LanguagesApi.html#get_translations_organization) | **GET** /api/v2/languages/translations/organization | Get effective translation for an organization by language|
+|[**get_translations_users_user_id**](LanguagesApi.html#get_translations_users_user_id) | **GET** /api/v2/languages/translations/users/{userId} | Get effective language translation for a user|
 |[**post_languages**](LanguagesApi.html#post_languages) | **POST** /api/v2/languages | Create Language|
 |[**put_language_id**](LanguagesApi.html#put_language_id) | **PUT** /api/v2/languages/{languageId} | Update Language|
 {: class="table table-striped"}
 
 <a name="delete_language_id"></a>
@@ -179,9 +183,227 @@
 
 
 ### Return type
 
 [**LanguageEntityListing**](LanguageEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_translations"></a>
+
+## -[**AvailableTranslations**](AvailableTranslations.html) get_translations
+
+Get all available languages for translation
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::LanguagesApi.new
+
+begin
+  #Get all available languages for translation
+  result = api_instance.get_translations
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LanguagesApi->get_translations: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AvailableTranslations**](AvailableTranslations.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_translations_builtin"></a>
+
+## -Hash&lt;String, Object&gt;** get_translations_builtin(language)
+
+Get the builtin translation for a language
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::LanguagesApi.new
+
+language = "language_example" # String | The language of the builtin translation to retrieve
+
+
+begin
+  #Get the builtin translation for a language
+  result = api_instance.get_translations_builtin(language)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LanguagesApi->get_translations_builtin: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **language** | **String**| The language of the builtin translation to retrieve | 
+{: class="table table-striped"}
+
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_translations_organization"></a>
+
+## -Hash&lt;String, Object&gt;** get_translations_organization(language)
+
+Get effective translation for an organization by language
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::LanguagesApi.new
+
+language = "language_example" # String | The language of the translation to retrieve for the organization
+
+
+begin
+  #Get effective translation for an organization by language
+  result = api_instance.get_translations_organization(language)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LanguagesApi->get_translations_organization: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **language** | **String**| The language of the translation to retrieve for the organization | 
+{: class="table table-striped"}
+
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_translations_users_user_id"></a>
+
+## -Hash&lt;String, Object&gt;** get_translations_users_user_id(user_id)
+
+Get effective language translation for a user
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::LanguagesApi.new
+
+user_id = "user_id_example" # String | The user id
+
+
+begin
+  #Get effective language translation for a user
+  result = api_instance.get_translations_users_user_id(user_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LanguagesApi->get_translations_users_user_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user id | 
+{: class="table table-striped"}
+
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
  - **Accept**: application/json