class ApiGeoClient::RgionsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

regions_code_departements_get(code, opts = {}) click to toggle source

Renvoi les départements d'une région @param code Code de la région @param [Hash] opts the optional parameters @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse (default to [“nom”,“code”]) @return [Departement]

# File lib/api_geo_client/api/rgions_api.rb, line 27
def regions_code_departements_get(code, opts = {})
  data, _status_code, _headers = regions_code_departements_get_with_http_info(code, opts)
  data
end
regions_code_departements_get_with_http_info(code, opts = {}) click to toggle source

Renvoi les départements d&#39;une région @param code Code de la région @param [Hash] opts the optional parameters @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse @return [Array<(Departement, Fixnum, Hash)>] Departement data, response status code and response headers

# File lib/api_geo_client/api/rgions_api.rb, line 37
def regions_code_departements_get_with_http_info(code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RgionsApi.regions_code_departements_get ...'
  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 RgionsApi.regions_code_departements_get"
  end
  if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['nom', 'code'].include?(item) }
    fail ArgumentError, 'invalid value for "fields", must include one of nom, code'
  end
  # resource path
  local_var_path = '/regions/{code}/departements'.sub('{' + 'code' + '}', code.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Departement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RgionsApi#regions_code_departements_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
regions_code_get(code, opts = {}) click to toggle source

Récupérer les informations concernant une région @param code Code de la région @param [Hash] opts the optional parameters @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse (default to [“nom”,“code”]) @return [Departement]

# File lib/api_geo_client/api/rgions_api.rb, line 83
def regions_code_get(code, opts = {})
  data, _status_code, _headers = regions_code_get_with_http_info(code, opts)
  data
end
regions_code_get_with_http_info(code, opts = {}) click to toggle source

Récupérer les informations concernant une région @param code Code de la région @param [Hash] opts the optional parameters @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse @return [Array<(Departement, Fixnum, Hash)>] Departement data, response status code and response headers

# File lib/api_geo_client/api/rgions_api.rb, line 93
def regions_code_get_with_http_info(code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RgionsApi.regions_code_get ...'
  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 RgionsApi.regions_code_get"
  end
  if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['nom', 'code'].include?(item) }
    fail ArgumentError, 'invalid value for "fields", must include one of nom, code'
  end
  # resource path
  local_var_path = '/regions/{code}'.sub('{' + 'code' + '}', code.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Departement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RgionsApi#regions_code_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
regions_get(opts = {}) click to toggle source

Recherche des régions @param [Hash] opts the optional parameters @option opts [String] :code Code de la région @option opts [String] :nom Nom de la région @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse (default to [“nom”,“code”]) @return [Array<Region>]

# File lib/api_geo_client/api/rgions_api.rb, line 140
def regions_get(opts = {})
  data, _status_code, _headers = regions_get_with_http_info(opts)
  data
end
regions_get_with_http_info(opts = {}) click to toggle source

Recherche des régions @param [Hash] opts the optional parameters @option opts [String] :code Code de la région @option opts [String] :nom Nom de la région @option opts [Array<String>] :fields Liste des champs souhaités dans la réponse @return [Array<(Array<Region>, Fixnum, Hash)>] Array<Region> data, response status code and response headers

# File lib/api_geo_client/api/rgions_api.rb, line 151
def regions_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RgionsApi.regions_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['nom', 'code'].include?(item) }
    fail ArgumentError, 'invalid value for "fields", must include one of nom, code'
  end
  # resource path
  local_var_path = '/regions'

  # query parameters
  query_params = {}
  query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
  query_params[:'nom'] = opts[:'nom'] if !opts[:'nom'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<Region>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RgionsApi#regions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end