api_geo_client 1.0.0

data/config.json

@@ -0,0 +1,10 @@
+{
+  "gemName": "api_geo_client",
+  "gemAuthor": "Armand Mégrot",
+  "gemAuthorEmail": "armand.megrot@cashbee.fr",
+  "gemSummary": "API Géo Ruby Gem",
+  "gemDescription": "API Géo. More info at https://api.gouv.fr/api/api-geo.html. Generated by Cashbee https://www.cashbee.fr",
+  "gemHomepage": "https://github.com/cashbee-team/api_geo_client",
+  "moduleName": "ApiGeoClient",
+  "gemLicense": "MIT"
+}

data/docs/Commune.md

@@ -0,0 +1,18 @@
+# ApiGeoClient::Commune
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Code INSEE de la commune | [optional] 
+**nom** | **String** | Nom de la commune | [optional] 
+**codes_postaux** | **Array<String>** | Liste des codes postaux associés à la commune | [optional] 
+**code_departement** | **String** | Code du département associé à la commune | [optional] 
+**code_region** | **String** | Code de la région associée à la commune | [optional] 
+**departement** | [**Departement**](Departement.md) |  | [optional] 
+**region** | [**Region**](Region.md) |  | [optional] 
+**population** | **Integer** | Population municipale | [optional] 
+**surface** | **Float** | Surface de la commune, en mètres-carrés | [optional] 
+**centre** | **Object** | Centre de la commune (Point GeoJSON) | [optional] 
+**contour** | **Object** | Contour de la commune (Polygon GeoJSON) | [optional] 
+
+

data/docs/CommunesApi.md

@@ -0,0 +1,183 @@
+# ApiGeoClient::CommunesApi
+
+All URIs are relative to *https://geo.api.gouv.fr*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**communes_code_get**](CommunesApi.md#communes_code_get) | **GET** /communes/{code} | Récupérer les informations concernant une commune
+[**communes_get**](CommunesApi.md#communes_get) | **GET** /communes | Recherche des communes
+[**departements_code_communes_get**](CommunesApi.md#departements_code_communes_get) | **GET** /departements/{code}/communes | Renvoi les communes d'un département
+
+
+# **communes_code_get**
+> Commune communes_code_get(code, opts)
+
+Récupérer les informations concernant une commune
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::CommunesApi.new
+
+code = 'code_example' # String | Code INSEE de la commune
+
+opts = { 
+  fields: ['[\"nom\",\"code\",\"codesPostaux\",\"codeDepartement\",\"codeRegion\",\"population\"]'], # Array<String> | Liste des champs souhaités dans la réponse
+  format: 'json', # String | Format de réponse attendu
+  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
+}
+
+begin
+  #Récupérer les informations concernant une commune
+  result = api_instance.communes_code_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling CommunesApi->communes_code_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code INSEE de la commune | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;,&quot;codesPostaux&quot;,&quot;codeDepartement&quot;,&quot;codeRegion&quot;,&quot;population&quot;]]
+ **format** | **String**| Format de réponse attendu | [optional] [default to json]
+ **geometry** | **String**| Géométrie à utiliser pour la sortie géographique | [optional] [default to centre]
+
+### Return type
+
+[**Commune**](Commune.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **communes_get**
+> Array&lt;Commune&gt; communes_get(opts)
+
+Recherche des communes
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::CommunesApi.new
+
+opts = { 
+  code_postal: 'code_postal_example', # String | Code postal associé
+  lat: 3.4, # Float | Latitude (en degrés)
+  lon: 3.4, # Float | Longitude (en degrés)
+  nom: 'nom_example', # String | Nom de la commune
+  boost: 'boost_example', # String | Mode de boost de la recherche par nom
+  code: 'code_example', # String | Code de la commune
+  code_departement: 'code_departement_example', # String | Code du département associé
+  code_region: 'code_region_example', # String | Code de la région associée
+  fields: ['[\"nom\",\"code\",\"codesPostaux\",\"codeDepartement\",\"codeRegion\",\"population\"]'], # Array<String> | Liste des champs souhaités dans la réponse
+  format: 'json', # String | Format de réponse attendu
+  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
+}
+
+begin
+  #Recherche des communes
+  result = api_instance.communes_get(opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling CommunesApi->communes_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code_postal** | **String**| Code postal associé | [optional] 
+ **lat** | **Float**| Latitude (en degrés) | [optional] 
+ **lon** | **Float**| Longitude (en degrés) | [optional] 
+ **nom** | **String**| Nom de la commune | [optional] 
+ **boost** | **String**| Mode de boost de la recherche par nom | [optional] 
+ **code** | **String**| Code de la commune | [optional] 
+ **code_departement** | **String**| Code du département associé | [optional] 
+ **code_region** | **String**| Code de la région associée | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;,&quot;codesPostaux&quot;,&quot;codeDepartement&quot;,&quot;codeRegion&quot;,&quot;population&quot;]]
+ **format** | **String**| Format de réponse attendu | [optional] [default to json]
+ **geometry** | **String**| Géométrie à utiliser pour la sortie géographique | [optional] [default to centre]
+
+### Return type
+
+[**Array&lt;Commune&gt;**](Commune.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **departements_code_communes_get**
+> Commune departements_code_communes_get(code, opts)
+
+Renvoi les communes d'un département
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::CommunesApi.new
+
+code = 'code_example' # String | Code du département
+
+opts = { 
+  fields: ['[\"nom\",\"code\",\"codesPostaux\",\"codeDepartement\",\"codeRegion\",\"population\"]'], # Array<String> | Liste des champs souhaités dans la réponse
+  format: 'json', # String | Format de réponse attendu
+  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
+}
+
+begin
+  #Renvoi les communes d'un département
+  result = api_instance.departements_code_communes_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling CommunesApi->departements_code_communes_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code du département | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;,&quot;codesPostaux&quot;,&quot;codeDepartement&quot;,&quot;codeRegion&quot;,&quot;population&quot;]]
+ **format** | **String**| Format de réponse attendu | [optional] [default to json]
+ **geometry** | **String**| Géométrie à utiliser pour la sortie géographique | [optional] [default to centre]
+
+### Return type
+
+[**Commune**](Commune.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Departement.md

@@ -0,0 +1,11 @@
+# ApiGeoClient::Departement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Code du département | [optional] 
+**nom** | **String** | Nom du département | [optional] 
+**code_region** | **String** | Code de la région | [optional] 
+**region** | [**Region**](Region.md) |  | [optional] 
+
+

data/docs/DpartementsApi.md

@@ -0,0 +1,215 @@
+# ApiGeoClient::DpartementsApi
+
+All URIs are relative to *https://geo.api.gouv.fr*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**departements_code_communes_get**](DpartementsApi.md#departements_code_communes_get) | **GET** /departements/{code}/communes | Renvoi les communes d'un département
+[**departements_code_get**](DpartementsApi.md#departements_code_get) | **GET** /departements/{code} | Récupérer les informations concernant un département
+[**departements_get**](DpartementsApi.md#departements_get) | **GET** /departements | Recherche des départements
+[**regions_code_departements_get**](DpartementsApi.md#regions_code_departements_get) | **GET** /regions/{code}/departements | Renvoi les départements d'une région
+
+
+# **departements_code_communes_get**
+> Commune departements_code_communes_get(code, opts)
+
+Renvoi les communes d'un département
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::DpartementsApi.new
+
+code = 'code_example' # String | Code du département
+
+opts = { 
+  fields: ['[\"nom\",\"code\",\"codesPostaux\",\"codeDepartement\",\"codeRegion\",\"population\"]'], # Array<String> | Liste des champs souhaités dans la réponse
+  format: 'json', # String | Format de réponse attendu
+  geometry: 'centre' # String | Géométrie à utiliser pour la sortie géographique
+}
+
+begin
+  #Renvoi les communes d'un département
+  result = api_instance.departements_code_communes_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling DpartementsApi->departements_code_communes_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code du département | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;,&quot;codesPostaux&quot;,&quot;codeDepartement&quot;,&quot;codeRegion&quot;,&quot;population&quot;]]
+ **format** | **String**| Format de réponse attendu | [optional] [default to json]
+ **geometry** | **String**| Géométrie à utiliser pour la sortie géographique | [optional] [default to centre]
+
+### Return type
+
+[**Commune**](Commune.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **departements_code_get**
+> Departement departements_code_get(code, opts)
+
+Récupérer les informations concernant un département
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::DpartementsApi.new
+
+code = 'code_example' # String | Code du département
+
+opts = { 
+  fields: ['[\"nom\",\"code\",\"codeRegion\"]'] # Array<String> | Liste des champs souhaités dans la réponse
+}
+
+begin
+  #Récupérer les informations concernant un département
+  result = api_instance.departements_code_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling DpartementsApi->departements_code_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code du département | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;,&quot;codeRegion&quot;]]
+
+### Return type
+
+[**Departement**](Departement.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **departements_get**
+> Array&lt;Departement&gt; departements_get(opts)
+
+Recherche des départements
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::DpartementsApi.new
+
+opts = { 
+  code: 'code_example', # String | Code du département
+  code_region: 'code_region_example', # String | Code région associé
+  nom: 'nom_example', # String | Nom du département
+  fields: ['[\"nom\",\"code\",\"codeRegion\"]'] # Array<String> | Liste des champs souhaités dans la réponse
+}
+
+begin
+  #Recherche des départements
+  result = api_instance.departements_get(opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling DpartementsApi->departements_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code du département | [optional] 
+ **code_region** | **String**| Code région associé | [optional] 
+ **nom** | **String**| Nom du département | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;,&quot;codeRegion&quot;]]
+
+### Return type
+
+[**Array&lt;Departement&gt;**](Departement.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **regions_code_departements_get**
+> Departement regions_code_departements_get(code, opts)
+
+Renvoi les départements d'une région
+
+### Example
+```ruby
+# load the gem
+require 'api_geo_client'
+
+api_instance = ApiGeoClient::DpartementsApi.new
+
+code = 'code_example' # String | Code de la région
+
+opts = { 
+  fields: ['[\"nom\",\"code\"]'] # Array<String> | Liste des champs souhaités dans la réponse
+}
+
+begin
+  #Renvoi les départements d'une région
+  result = api_instance.regions_code_departements_get(code, opts)
+  p result
+rescue ApiGeoClient::ApiError => e
+  puts "Exception when calling DpartementsApi->regions_code_departements_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Code de la région | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Liste des champs souhaités dans la réponse | [optional] [default to [&quot;nom&quot;,&quot;code&quot;]]
+
+### Return type
+
+[**Departement**](Departement.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Error.md

@@ -0,0 +1,10 @@
+# ApiGeoClient::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Integer** | Code HTTP de l'erreur | [optional] 
+**message** | **String** | Libellé de l'erreur | [optional] 
+**description** | **String** | Explication | [optional] 
+
+