lib/purecloud/api/languages_api.rb in purecloud-0.35.1 vs lib/purecloud/api/languages_api.rb in purecloud-0.36.1
- old
+ new
@@ -1,51 +1,59 @@
+=begin
+PureCloud API
+
+PureCloud API
+
+OpenAPI spec version: v1
+Contact: chuck.pulfer@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: http://www.inin.com
+
+=end
+
require "uri"
module PureCloud
class LanguagesApi
attr_accessor :api_client
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
- # Get the list of supported languages.
+ # Delete Language
#
+ # @param language_id Language ID
# @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
- # @return [LanguageEntityListing]
- def get_languages(opts = {})
- data, status_code, headers = get_languages_with_http_info(opts)
- return data
+ # @return [nil]
+ def delete_language_id(language_id, opts = {})
+ delete_language_id_with_http_info(language_id, opts)
+ return nil
end
- # Get the list of supported languages.
+ # Delete Language
#
+ # @param language_id Language ID
# @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
- # @return [Array<(LanguageEntityListing, Fixnum, Hash)>] LanguageEntityListing data, response status code and response headers
- def get_languages_with_http_info(opts = {})
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+ def delete_language_id_with_http_info(language_id, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: LanguagesApi#get_languages ..."
+ @api_client.config.logger.debug "Calling API: LanguagesApi#delete_language_id ..."
end
- if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order'])
- fail 'invalid value for "sort_order", must be one of [ascending, descending]'
- 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
- path = "/api/v2/languages".sub('{format}','json')
+ local_var_path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
# 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']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -60,47 +68,48 @@
form_params = {}
# http body (model)
post_body = nil
-
auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:GET, path,
+ 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,
- :return_type => 'LanguageEntityListing')
+ :auth_names => auth_names)
if @api_client.config.debugging
- @api_client.config.logger.debug "API called: LanguagesApi#get_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @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
- # Create Language
+ # Get language
#
+ # @param language_id Language ID
# @param [Hash] opts the optional parameters
- # @option opts [Language] :body Language
# @return [Language]
- def post_languages(opts = {})
- data, status_code, headers = post_languages_with_http_info(opts)
+ def get_language_id(language_id, opts = {})
+ data, status_code, headers = get_language_id_with_http_info(language_id, opts)
return data
end
- # Create Language
+ # Get language
#
+ # @param language_id Language ID
# @param [Hash] opts the optional parameters
- # @option opts [Language] :body Language
# @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
- def post_languages_with_http_info(opts = {})
+ def get_language_id_with_http_info(language_id, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: LanguagesApi#post_languages ..."
+ @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
- path = "/api/v2/languages".sub('{format}','json')
+ local_var_path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
# query parameters
query_params = {}
# header parameters
@@ -116,55 +125,62 @@
# form parameters
form_params = {}
# http body (model)
- post_body = @api_client.object_to_http_body(opts[:'body'])
+ post_body = nil
-
auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:POST, path,
+ 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#post_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @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 language
+ # Get the list of supported languages.
#
- # @param language_id Language ID
# @param [Hash] opts the optional parameters
- # @return [Language]
- def get_language_id(language_id, opts = {})
- data, status_code, headers = get_language_id_with_http_info(language_id, opts)
+ # @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)
+ # @return [LanguageEntityListing]
+ def get_languages(opts = {})
+ data, status_code, headers = get_languages_with_http_info(opts)
return data
end
- # Get language
+ # Get the list of supported languages.
#
- # @param language_id Language ID
# @param [Hash] opts the optional parameters
- # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
- def get_language_id_with_http_info(language_id, opts = {})
+ # @option opts [Integer] :page_size Page size
+ # @option opts [Integer] :page_number Page number
+ # @option opts [String] :sort_order Ascending or descending sort order
+ # @return [Array<(LanguageEntityListing, Fixnum, Hash)>] LanguageEntityListing data, response status code and response headers
+ def get_languages_with_http_info(opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: LanguagesApi#get_language_id ..."
+ @api_client.config.logger.debug "Calling API: LanguagesApi#get_languages ..."
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?
+ 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
- path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
+ 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']
# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
@@ -179,52 +195,46 @@
form_params = {}
# http body (model)
post_body = nil
-
auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:GET, path,
+ 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')
+ :return_type => 'LanguageEntityListing')
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}"
+ @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
- # Update Language
+ # Create Language
#
- # @param language_id Language ID
# @param [Hash] opts the optional parameters
# @option opts [Language] :body Language
# @return [Language]
- def put_language_id(language_id, opts = {})
- data, status_code, headers = put_language_id_with_http_info(language_id, opts)
+ def post_languages(opts = {})
+ data, status_code, headers = post_languages_with_http_info(opts)
return data
end
- # Update Language
+ # Create Language
#
- # @param language_id Language ID
# @param [Hash] opts the optional parameters
# @option opts [Language] :body Language
# @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
- def put_language_id_with_http_info(language_id, opts = {})
+ def post_languages_with_http_info(opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: LanguagesApi#put_language_id ..."
+ @api_client.config.logger.debug "Calling API: LanguagesApi#post_languages ..."
end
- # verify the required parameter 'language_id' is set
- fail "Missing the required parameter 'language_id' when calling put_language_id" if language_id.nil?
-
# resource path
- path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
+ local_var_path = "/api/v2/languages".sub('{format}','json')
# query parameters
query_params = {}
# header parameters
@@ -242,50 +252,51 @@
form_params = {}
# http body (model)
post_body = @api_client.object_to_http_body(opts[:'body'])
-
auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:PUT, path,
+ 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#put_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ @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
- # Delete Language
+ # Update Language
#
# @param language_id Language ID
# @param [Hash] opts the optional parameters
- # @return [nil]
- def delete_language_id(language_id, opts = {})
- delete_language_id_with_http_info(language_id, opts)
- return nil
+ # @option opts [Language] :body Language
+ # @return [Language]
+ def put_language_id(language_id, opts = {})
+ data, status_code, headers = put_language_id_with_http_info(language_id, opts)
+ return data
end
- # Delete Language
+ # Update Language
#
# @param language_id Language ID
# @param [Hash] opts the optional parameters
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
- def delete_language_id_with_http_info(language_id, opts = {})
+ # @option opts [Language] :body Language
+ # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
+ def put_language_id_with_http_info(language_id, opts = {})
if @api_client.config.debugging
- @api_client.config.logger.debug "Calling API: LanguagesApi#delete_language_id ..."
+ @api_client.config.logger.debug "Calling API: LanguagesApi#put_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?
+ fail "Missing the required parameter 'language_id' when calling put_language_id" if language_id.nil?
# resource path
- path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
+ local_var_path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
# query parameters
query_params = {}
# header parameters
@@ -301,26 +312,22 @@
# form parameters
form_params = {}
# http body (model)
- post_body = nil
+ post_body = @api_client.object_to_http_body(opts[:'body'])
-
auth_names = ['PureCloud Auth']
- data, status_code, headers = @api_client.call_api(:DELETE, path,
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
- :auth_names => auth_names)
+ :auth_names => auth_names,
+ :return_type => 'Language')
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}"
+ @api_client.config.logger.debug "API called: LanguagesApi#put_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
end
end
-
-
-
-