api_particulier 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 69af0dca4424823c2fa2cbaba141f4ccde38d45309ce3f4a878e3ae6105728aa
4
- data.tar.gz: 95b4443df163a996ca72416060d212b69fc2efc4dc00981699aa3d486e285993
3
+ metadata.gz: a298ccf67177b4cc148fa52a841bc8ece4c91d942c1f9ef02327925fdc328e1b
4
+ data.tar.gz: 22675a66c3f4006b3197d8cde6c7acf88da037f052ea59a75117fc9853e9eb11
5
5
  SHA512:
6
- metadata.gz: d5e1f0af171ee5808171f3e0d13b5cae816d0932422ba7eb5b083b148c339e31f2d9f513f0e874d71246c92062a463a2c9faac8c6d4143b9385685e7817da2b9
7
- data.tar.gz: 6c98f422268ae3cecf8f9e56296a1b3df56e5fa499e5b31f541b0e6c1598e55587d8ac5ad963275c87da12f9dd4689c5e7afd7de966a7ad8514e6601cb046ba9
6
+ metadata.gz: 9e0b01d253609c4e6f1b7d481814146a5eeff3fc77898cbc7e267cffe77a50a26a715e5affa8a6735a66bbe9a4d42de8d49e7c76fffad1b7ce144fe893accaf6
7
+ data.tar.gz: 3fad29288b39f2b82c78bdf9d214f7dd3d13f59b5280ee297a019d30ca2cc8f87b0f192636070dc188c16bcc0cadf4323880de2ed4afef6df98cf127fad49239
data/CHANGELOG.md CHANGED
@@ -6,6 +6,15 @@ adheres to [Semantic Versioning](https://semver.org/).
6
6
 
7
7
  ## [Unreleased]
8
8
 
9
+ ## [0.1.1] - 2026-05-05
10
+
11
+ ### Changed
12
+ - CNAF DSS (`dss.*_identite`) : `code_cog_insee_pays_naissance` is now
13
+ optional, mirroring the upstream OpenAPI change that made the lieu de
14
+ naissance attributes facultatifs.
15
+
16
+ ## [0.1.0]
17
+
9
18
  ### Added
10
19
  - Initial release — conforms to `clients/SPECS.md` §1–§20.
11
20
  - `production` / `staging` environments with `base_url` override.
@@ -13,7 +13,7 @@ module ApiParticulier
13
13
  # [FranceConnect] Statut étudiant boursier
14
14
  # Logical endpoint: /cnous/etudiant_boursier/france_connect
15
15
  # Versions available: [3, 4] — default: 4
16
- def etudiant_boursier(version: nil, recipient: nil)
16
+ def etudiant_boursier(version: nil, recipient: nil, campaign_year: nil)
17
17
  path =
18
18
  case version || 4
19
19
  when 3
@@ -24,13 +24,13 @@ module ApiParticulier
24
24
  else
25
25
  raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/france_connect; supported: [3, 4]"
26
26
  end
27
- @client.get(path, params: { "recipient" => recipient }.compact)
27
+ @client.get(path, params: { "recipient" => recipient, "campaignYear" => campaign_year }.compact)
28
28
  end
29
29
 
30
30
  # [Identité] Statut étudiant boursier
31
31
  # Logical endpoint: /cnous/etudiant_boursier/identite
32
32
  # Versions available: [3, 4] — default: 4
33
- def etudiant_boursier_identite(version: nil, recipient: nil, nom_naissance:, prenoms:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:, sexe_etat_civil: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
33
+ def etudiant_boursier_identite(version: nil, recipient: nil, nom_naissance:, prenoms:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:, sexe_etat_civil: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil, campaign_year: nil)
34
34
  path =
35
35
  case version || 4
36
36
  when 3
@@ -41,13 +41,13 @@ module ApiParticulier
41
41
  else
42
42
  raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/identite; supported: [3, 4]"
43
43
  end
44
- @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
44
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance, "campaignYear" => campaign_year }.compact)
45
45
  end
46
46
 
47
47
  # [INE] Statut étudiant boursier
48
48
  # Logical endpoint: /cnous/etudiant_boursier/ine
49
49
  # Versions available: [3, 4] — default: 4
50
- def ine(version: nil, recipient: nil, ine:)
50
+ def ine(version: nil, recipient: nil, ine:, campaign_year: nil)
51
51
  path =
52
52
  case version || 4
53
53
  when 3
@@ -58,7 +58,7 @@ module ApiParticulier
58
58
  else
59
59
  raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/ine; supported: [3, 4]"
60
60
  end
61
- @client.get(path, params: { "recipient" => recipient, "ine" => ine }.compact)
61
+ @client.get(path, params: { "recipient" => recipient, "ine" => ine, "campaignYear" => campaign_year }.compact)
62
62
  end
63
63
  end
64
64
  end
@@ -27,7 +27,7 @@ module ApiParticulier
27
27
  # [Identité] Statut allocation adulte handicapé (AAH)
28
28
  # Logical endpoint: /dss/allocation_adulte_handicape/identite
29
29
  # Versions available: [3] — default: 3
30
- def allocation_adulte_handicape_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
30
+ def allocation_adulte_handicape_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
31
31
  path =
32
32
  case version || 3
33
33
  when 3
@@ -55,7 +55,7 @@ module ApiParticulier
55
55
  # [Identité] Statut allocation d'éducation de l'enfant handicapé (AEEH)
56
56
  # Logical endpoint: /dss/allocation_enfant_handicape/identite
57
57
  # Versions available: [3] — default: 3
58
- def allocation_enfant_handicape_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
58
+ def allocation_enfant_handicape_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
59
59
  path =
60
60
  case version || 3
61
61
  when 3
@@ -83,7 +83,7 @@ module ApiParticulier
83
83
  # [Identité] Statut allocation de soutien familial (ASF)
84
84
  # Logical endpoint: /dss/allocation_soutien_familial/identite
85
85
  # Versions available: [3] — default: 3
86
- def allocation_soutien_familial_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
86
+ def allocation_soutien_familial_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
87
87
  path =
88
88
  case version || 3
89
89
  when 3
@@ -111,7 +111,7 @@ module ApiParticulier
111
111
  # [Identité] Statut complémentaire santé solidaire (C2S)
112
112
  # Logical endpoint: /dss/complementaire_sante_solidaire/identite
113
113
  # Versions available: [3] — default: 3
114
- def complementaire_sante_solidaire_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
114
+ def complementaire_sante_solidaire_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
115
115
  path =
116
116
  case version || 3
117
117
  when 3
@@ -139,7 +139,7 @@ module ApiParticulier
139
139
  # [Identité] Participation familiale EAJE
140
140
  # Logical endpoint: /dss/participation_familiale_eaje/identite
141
141
  # Versions available: [3] — default: 3
142
- def participation_familiale_eaje_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
142
+ def participation_familiale_eaje_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
143
143
  path =
144
144
  case version || 3
145
145
  when 3
@@ -167,7 +167,7 @@ module ApiParticulier
167
167
  # [Identité] Statut prime d'activité
168
168
  # Logical endpoint: /dss/prime_activite/identite
169
169
  # Versions available: [3] — default: 3
170
- def prime_activite_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
170
+ def prime_activite_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
171
171
  path =
172
172
  case version || 3
173
173
  when 3
@@ -195,7 +195,7 @@ module ApiParticulier
195
195
  # [Identité] Quotient familial CAF & MSA
196
196
  # Logical endpoint: /dss/quotient_familial/identite
197
197
  # Versions available: [3] — default: 3
198
- def quotient_familial_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil, annee: nil, mois: nil)
198
+ def quotient_familial_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil, annee: nil, mois: nil)
199
199
  path =
200
200
  case version || 3
201
201
  when 3
@@ -223,7 +223,7 @@ module ApiParticulier
223
223
  # [Identité] Statut revenu de solidarité active (RSA)
224
224
  # Logical endpoint: /dss/revenu_solidarite_active/identite
225
225
  # Versions available: [3] — default: 3
226
- def revenu_solidarite_active_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
226
+ def revenu_solidarite_active_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil:, code_cog_insee_pays_naissance: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
227
227
  path =
228
228
  case version || 3
229
229
  when 3
@@ -1,3 +1,3 @@
1
1
  module ApiParticulier
2
- VERSION = '0.1.0'.freeze
2
+ VERSION = '0.1.1'.freeze
3
3
  end
metadata CHANGED
@@ -1,13 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: api_particulier
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - DINUM
8
+ autorequire:
8
9
  bindir: bin
9
10
  cert_chain: []
10
- date: 1980-01-02 00:00:00.000000000 Z
11
+ date: 2026-05-05 00:00:00.000000000 Z
11
12
  dependencies:
12
13
  - !ruby/object:Gem::Dependency
13
14
  name: faraday
@@ -87,6 +88,7 @@ metadata:
87
88
  bug_tracker_uri: https://github.com/datagouv/apistration/issues
88
89
  documentation_uri: https://particulier.api.gouv.fr/v3/
89
90
  rubygems_mfa_required: 'true'
91
+ post_install_message:
90
92
  rdoc_options: []
91
93
  require_paths:
92
94
  - lib
@@ -101,7 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
101
103
  - !ruby/object:Gem::Version
102
104
  version: '0'
103
105
  requirements: []
104
- rubygems_version: 3.6.9
106
+ rubygems_version: 3.5.22
107
+ signing_key:
105
108
  specification_version: 4
106
109
  summary: Official Ruby client for API Particulier v3
107
110
  test_files: []