class PureCloud::LanguagesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/purecloud/api/languages_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_language_id(language_id, opts = {}) click to toggle source

Delete Language (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages/{languageId} @param language_id Language ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloud/api/languages_api.rb, line 32
def delete_language_id(language_id, opts = {})
  delete_language_id_with_http_info(language_id, opts)
  return nil
end
delete_language_id_with_http_info(language_id, opts = {}) click to toggle source

Delete Language (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages/{languageId} @param language_id Language ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 42
def delete_language_id_with_http_info(language_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#delete_language_id ..."
  end
  
  # verify the required parameter 'language_id' is set
  fail "Missing the required parameter 'language_id' when calling delete_language_id" if language_id.nil?
  
  # resource path
  local_var_path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#delete_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_languages_language_id(language_id, opts = {}) click to toggle source

Delete Language

@param language_id Language ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloud/api/languages_api.rb, line 91
def delete_languages_language_id(language_id, opts = {})
  delete_languages_language_id_with_http_info(language_id, opts)
  return nil
end
delete_languages_language_id_with_http_info(language_id, opts = {}) click to toggle source

Delete Language

@param language_id Language ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 101
def delete_languages_language_id_with_http_info(language_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#delete_languages_language_id ..."
  end
  
  # verify the required parameter 'language_id' is set
  fail "Missing the required parameter 'language_id' when calling delete_languages_language_id" if language_id.nil?
  
  # resource path
  local_var_path = "/api/v2/routing/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#delete_languages_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_language_id(language_id, opts = {}) click to toggle source

Get language (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages/{languageId} @param language_id Language ID @param [Hash] opts the optional parameters @return [Language]

# File lib/purecloud/api/languages_api.rb, line 150
def get_language_id(language_id, opts = {})
  data, status_code, headers = get_language_id_with_http_info(language_id, opts)
  return data
end
get_language_id_with_http_info(language_id, opts = {}) click to toggle source

Get language (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages/{languageId} @param language_id Language ID @param [Hash] opts the optional parameters @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 160
def get_language_id_with_http_info(language_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_language_id ..."
  end
  
  # verify the required parameter 'language_id' is set
  fail "Missing the required parameter 'language_id' when calling get_language_id" if language_id.nil?
  
  # resource path
  local_var_path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Language')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_languages(opts = {}) click to toggle source

Get the list of supported languages. (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :sort_order Ascending or descending sort order (default to ASC) @option opts [String] :name Name @return [LanguageEntityListing]

# File lib/purecloud/api/languages_api.rb, line 213
def get_languages(opts = {})
  data, status_code, headers = get_languages_with_http_info(opts)
  return data
end
get_languages_language_id(language_id, opts = {}) click to toggle source

Get language

@param language_id Language ID @param [Hash] opts the optional parameters @return [Language]

# File lib/purecloud/api/languages_api.rb, line 281
def get_languages_language_id(language_id, opts = {})
  data, status_code, headers = get_languages_language_id_with_http_info(language_id, opts)
  return data
end
get_languages_language_id_with_http_info(language_id, opts = {}) click to toggle source

Get language

@param language_id Language ID @param [Hash] opts the optional parameters @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 291
def get_languages_language_id_with_http_info(language_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_languages_language_id ..."
  end
  
  # verify the required parameter 'language_id' is set
  fail "Missing the required parameter 'language_id' when calling get_languages_language_id" if language_id.nil?
  
  # resource path
  local_var_path = "/api/v2/routing/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Language')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_languages_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_languages_with_http_info(opts = {}) click to toggle source

Get the list of supported languages. (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size @option opts [Integer] :page_number Page number @option opts [String] :sort_order Ascending or descending sort order @option opts [String] :name Name @return [Array<(LanguageEntityListing, Fixnum, Hash)>] LanguageEntityListing data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 226
def get_languages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_languages ..."
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/languages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LanguageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_translations(opts = {}) click to toggle source

Get all available languages for translation

@param [Hash] opts the optional parameters @return [AvailableTranslations]

# File lib/purecloud/api/languages_api.rb, line 340
def get_translations(opts = {})
  data, status_code, headers = get_translations_with_http_info(opts)
  return data
end
get_translations_builtin(language, opts = {}) click to toggle source

Get the builtin translation for a language

@param language The language of the builtin translation to retrieve @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/purecloud/api/languages_api.rb, line 396
def get_translations_builtin(language, opts = {})
  data, status_code, headers = get_translations_builtin_with_http_info(language, opts)
  return data
end
get_translations_builtin_with_http_info(language, opts = {}) click to toggle source

Get the builtin translation for a language

@param language The language of the builtin translation to retrieve @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 406
def get_translations_builtin_with_http_info(language, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_translations_builtin ..."
  end
  
  # verify the required parameter 'language' is set
  fail "Missing the required parameter 'language' when calling get_translations_builtin" if language.nil?
  
  # resource path
  local_var_path = "/api/v2/languages/translations/builtin".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'language'] = language

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_translations_builtin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_translations_organization(language, opts = {}) click to toggle source

Get effective translation for an organization by language

@param language The language of the translation to retrieve for the organization @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/purecloud/api/languages_api.rb, line 457
def get_translations_organization(language, opts = {})
  data, status_code, headers = get_translations_organization_with_http_info(language, opts)
  return data
end
get_translations_organization_with_http_info(language, opts = {}) click to toggle source

Get effective translation for an organization by language

@param language The language of the translation to retrieve for the organization @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 467
def get_translations_organization_with_http_info(language, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_translations_organization ..."
  end
  
  # verify the required parameter 'language' is set
  fail "Missing the required parameter 'language' when calling get_translations_organization" if language.nil?
  
  # resource path
  local_var_path = "/api/v2/languages/translations/organization".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'language'] = language

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_translations_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_translations_users_user_id(user_id, opts = {}) click to toggle source

Get effective language translation for a user

@param user_id The user id @param [Hash] opts the optional parameters @return [Hash<String, Object>]

# File lib/purecloud/api/languages_api.rb, line 518
def get_translations_users_user_id(user_id, opts = {})
  data, status_code, headers = get_translations_users_user_id_with_http_info(user_id, opts)
  return data
end
get_translations_users_user_id_with_http_info(user_id, opts = {}) click to toggle source

Get effective language translation for a user

@param user_id The user id @param [Hash] opts the optional parameters @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 528
def get_translations_users_user_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_translations_users_user_id ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling get_translations_users_user_id" if user_id.nil?
  
  # resource path
  local_var_path = "/api/v2/languages/translations/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_translations_users_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_translations_with_http_info(opts = {}) click to toggle source

Get all available languages for translation

@param [Hash] opts the optional parameters @return [Array<(AvailableTranslations, Fixnum, Hash)>] AvailableTranslations data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 349
def get_translations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#get_translations ..."
  end
  
  # resource path
  local_var_path = "/api/v2/languages/translations".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AvailableTranslations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#get_translations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_languages(body, opts = {}) click to toggle source

Create Language (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages @param body Language @param [Hash] opts the optional parameters @return [Language]

# File lib/purecloud/api/languages_api.rb, line 578
def post_languages(body, opts = {})
  data, status_code, headers = post_languages_with_http_info(body, opts)
  return data
end
post_languages_with_http_info(body, opts = {}) click to toggle source

Create Language (Deprecated) This endpoint is deprecated. It has been moved to /routing/languages @param body Language @param [Hash] opts the optional parameters @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers

# File lib/purecloud/api/languages_api.rb, line 588
def post_languages_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguagesApi#post_languages ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_languages" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/languages".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Language')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguagesApi#post_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end