class DevmeSdk::CountryApi
Attributes
Public Class Methods
# File lib/devme-sdk-ruby/api/country_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get country facts and information @param code [String] code - country code ISO 4217 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand - expand properties @option opts [Array<String>] :exclude exclude - exclude properties @option opts [String] :language language - localisation language @return [GetCountryDetailsOut]
# File lib/devme-sdk-ruby/api/country_api.rb, line 30 def v1_get_country_details(code, opts = {}) data, _status_code, _headers = v1_get_country_details_with_http_info(code, opts) data end
Get country facts and information @param code [String] code - country code ISO 4217 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand - expand properties @option opts [Array<String>] :exclude exclude - exclude properties @option opts [String] :language language - localisation language @return [Array<(GetCountryDetailsOut
, Integer, Hash)>] GetCountryDetailsOut
data, response status code and response headers
# File lib/devme-sdk-ruby/api/country_api.rb, line 42 def v1_get_country_details_with_http_info(code, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CountryApi.v1_get_country_details ...' end # verify the required parameter 'code' is set if @api_client.config.client_side_validation && code.nil? fail ArgumentError, "Missing the required parameter 'code' when calling CountryApi.v1_get_country_details" end allowable_values = ["en", "ar", "de", "es", "fr", "ja", "ko", "pt", "ru"] if @api_client.config.client_side_validation && opts[:'language'] && !allowable_values.include?(opts[:'language']) fail ArgumentError, "invalid value for \"language\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1-get-country-details' # query parameters query_params = opts[:query_params] || {} query_params[:'code'] = code query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil? query_params[:'exclude'] = @api_client.build_collection_param(opts[:'exclude'], :multi) if !opts[:'exclude'].nil? query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'GetCountryDetailsOut' # auth_names auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'APIKeyQueryParam'] new_options = opts.merge( :operation => :"CountryApi.v1_get_country_details", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CountryApi#v1_get_country_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of all countries @param [Hash] opts the optional parameters @option opts [Array<String>] :code code - country code ISO 4217 @option opts [Array<String>] :expand expand - expand properties @option opts [Array<String>] :exclude exclude - exclude properties @option opts [String] :language language - localisation language @option opts [Array<String>] :sort sort - sort properties @option opts [String] :page page - page number @option opts [String] :page_size pageSize - page size @return [ListCountriesOut]
# File lib/devme-sdk-ruby/api/country_api.rb, line 108 def v1_list_countries(opts = {}) data, _status_code, _headers = v1_list_countries_with_http_info(opts) data end
Get list of all countries @param [Hash] opts the optional parameters @option opts [Array<String>] :code code - country code ISO 4217 @option opts [Array<String>] :expand expand - expand properties @option opts [Array<String>] :exclude exclude - exclude properties @option opts [String] :language language - localisation language @option opts [Array<String>] :sort sort - sort properties @option opts [String] :page page - page number @option opts [String] :page_size pageSize - page size @return [Array<(ListCountriesOut
, Integer, Hash)>] ListCountriesOut
data, response status code and response headers
# File lib/devme-sdk-ruby/api/country_api.rb, line 123 def v1_list_countries_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CountryApi.v1_list_countries ...' end allowable_values = ["en", "ar", "de", "es", "fr", "ja", "ko", "pt", "ru"] if @api_client.config.client_side_validation && opts[:'language'] && !allowable_values.include?(opts[:'language']) fail ArgumentError, "invalid value for \"language\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1-list-countries' # query parameters query_params = opts[:query_params] || {} query_params[:'code'] = @api_client.build_collection_param(opts[:'code'], :multi) if !opts[:'code'].nil? query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil? query_params[:'exclude'] = @api_client.build_collection_param(opts[:'exclude'], :multi) if !opts[:'exclude'].nil? query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil? query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListCountriesOut' # auth_names auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'APIKeyQueryParam'] new_options = opts.merge( :operation => :"CountryApi.v1_list_countries", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: CountryApi#v1_list_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end