api_particulier 0.1.0

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.
Files changed (34) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +23 -0
  3. data/LICENSE +21 -0
  4. data/README.md +66 -0
  5. data/lib/api_particulier/client.rb +76 -0
  6. data/lib/api_particulier/commons/auth/bearer_token.rb +21 -0
  7. data/lib/api_particulier/commons/auth/strategy.rb +13 -0
  8. data/lib/api_particulier/commons/client_base.rb +128 -0
  9. data/lib/api_particulier/commons/configuration.rb +101 -0
  10. data/lib/api_particulier/commons/errors.rb +84 -0
  11. data/lib/api_particulier/commons/middleware/authentication.rb +49 -0
  12. data/lib/api_particulier/commons/middleware/envelope.rb +31 -0
  13. data/lib/api_particulier/commons/middleware/error_handler.rb +106 -0
  14. data/lib/api_particulier/commons/middleware/logging.rb +70 -0
  15. data/lib/api_particulier/commons/middleware/rate_limit.rb +17 -0
  16. data/lib/api_particulier/commons/rate_limit.rb +54 -0
  17. data/lib/api_particulier/commons/response.rb +32 -0
  18. data/lib/api_particulier/commons/siren.rb +37 -0
  19. data/lib/api_particulier/commons/siret.rb +37 -0
  20. data/lib/api_particulier/commons/user_agent.rb +16 -0
  21. data/lib/api_particulier/commons/version.rb +7 -0
  22. data/lib/api_particulier/commons.rb +23 -0
  23. data/lib/api_particulier/resources/ants.rb +28 -0
  24. data/lib/api_particulier/resources/cnous.rb +65 -0
  25. data/lib/api_particulier/resources/dsnj.rb +42 -0
  26. data/lib/api_particulier/resources/dss.rb +238 -0
  27. data/lib/api_particulier/resources/france_travail.rb +42 -0
  28. data/lib/api_particulier/resources/gip_mds.rb +42 -0
  29. data/lib/api_particulier/resources/men.rb +34 -0
  30. data/lib/api_particulier/resources/mesri.rb +56 -0
  31. data/lib/api_particulier/resources/sdh.rb +28 -0
  32. data/lib/api_particulier/version.rb +3 -0
  33. data/lib/api_particulier.rb +4 -0
  34. metadata +107 -0
@@ -0,0 +1,238 @@
1
+ # frozen_string_literal: true
2
+ # DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
3
+ # clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
4
+ # script instead.
5
+
6
+ module ApiParticulier
7
+ module Resources
8
+ class Dss
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ # [FranceConnect] Statut allocation adulte handicapé (AAH)
14
+ # Logical endpoint: /dss/allocation_adulte_handicape/france_connect
15
+ # Versions available: [3] — default: 3
16
+ def allocation_adulte_handicape(version: nil, recipient: nil)
17
+ path =
18
+ case version || 3
19
+ when 3
20
+ "/v3/dss/allocation_adulte_handicape/france_connect"
21
+ else
22
+ raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_adulte_handicape/france_connect; supported: [3]"
23
+ end
24
+ @client.get(path, params: { "recipient" => recipient }.compact)
25
+ end
26
+
27
+ # [Identité] Statut allocation adulte handicapé (AAH)
28
+ # Logical endpoint: /dss/allocation_adulte_handicape/identite
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)
31
+ path =
32
+ case version || 3
33
+ when 3
34
+ "/v3/dss/allocation_adulte_handicape/identite"
35
+ else
36
+ raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_adulte_handicape/identite; supported: [3]"
37
+ end
38
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
39
+ end
40
+
41
+ # [FranceConnect] Statut allocation d'éducation de l'enfant handicapé (AEEH)
42
+ # Logical endpoint: /dss/allocation_enfant_handicape/france_connect
43
+ # Versions available: [3] — default: 3
44
+ def allocation_enfant_handicape(version: nil, recipient: nil)
45
+ path =
46
+ case version || 3
47
+ when 3
48
+ "/v3/dss/allocation_enfant_handicape/france_connect"
49
+ else
50
+ raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_enfant_handicape/france_connect; supported: [3]"
51
+ end
52
+ @client.get(path, params: { "recipient" => recipient }.compact)
53
+ end
54
+
55
+ # [Identité] Statut allocation d'éducation de l'enfant handicapé (AEEH)
56
+ # Logical endpoint: /dss/allocation_enfant_handicape/identite
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)
59
+ path =
60
+ case version || 3
61
+ when 3
62
+ "/v3/dss/allocation_enfant_handicape/identite"
63
+ else
64
+ raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_enfant_handicape/identite; supported: [3]"
65
+ end
66
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
67
+ end
68
+
69
+ # [FranceConnect] Statut allocation de soutien familial (ASF)
70
+ # Logical endpoint: /dss/allocation_soutien_familial/france_connect
71
+ # Versions available: [3] — default: 3
72
+ def allocation_soutien_familial(version: nil, recipient: nil)
73
+ path =
74
+ case version || 3
75
+ when 3
76
+ "/v3/dss/allocation_soutien_familial/france_connect"
77
+ else
78
+ raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_soutien_familial/france_connect; supported: [3]"
79
+ end
80
+ @client.get(path, params: { "recipient" => recipient }.compact)
81
+ end
82
+
83
+ # [Identité] Statut allocation de soutien familial (ASF)
84
+ # Logical endpoint: /dss/allocation_soutien_familial/identite
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)
87
+ path =
88
+ case version || 3
89
+ when 3
90
+ "/v3/dss/allocation_soutien_familial/identite"
91
+ else
92
+ raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_soutien_familial/identite; supported: [3]"
93
+ end
94
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
95
+ end
96
+
97
+ # [FranceConnect] Statut complémentaire santé solidaire (C2S)
98
+ # Logical endpoint: /dss/complementaire_sante_solidaire/france_connect
99
+ # Versions available: [3] — default: 3
100
+ def complementaire_sante_solidaire(version: nil, recipient: nil)
101
+ path =
102
+ case version || 3
103
+ when 3
104
+ "/v3/dss/complementaire_sante_solidaire/france_connect"
105
+ else
106
+ raise ArgumentError, "version #{version.inspect} not available for /dss/complementaire_sante_solidaire/france_connect; supported: [3]"
107
+ end
108
+ @client.get(path, params: { "recipient" => recipient }.compact)
109
+ end
110
+
111
+ # [Identité] Statut complémentaire santé solidaire (C2S)
112
+ # Logical endpoint: /dss/complementaire_sante_solidaire/identite
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)
115
+ path =
116
+ case version || 3
117
+ when 3
118
+ "/v3/dss/complementaire_sante_solidaire/identite"
119
+ else
120
+ raise ArgumentError, "version #{version.inspect} not available for /dss/complementaire_sante_solidaire/identite; supported: [3]"
121
+ end
122
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
123
+ end
124
+
125
+ # [FranceConnect] Participation familiale EAJE
126
+ # Logical endpoint: /dss/participation_familiale_eaje/france_connect
127
+ # Versions available: [3] — default: 3
128
+ def participation_familiale_eaje(version: nil, recipient: nil)
129
+ path =
130
+ case version || 3
131
+ when 3
132
+ "/v3/dss/participation_familiale_eaje/france_connect"
133
+ else
134
+ raise ArgumentError, "version #{version.inspect} not available for /dss/participation_familiale_eaje/france_connect; supported: [3]"
135
+ end
136
+ @client.get(path, params: { "recipient" => recipient }.compact)
137
+ end
138
+
139
+ # [Identité] Participation familiale EAJE
140
+ # Logical endpoint: /dss/participation_familiale_eaje/identite
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)
143
+ path =
144
+ case version || 3
145
+ when 3
146
+ "/v3/dss/participation_familiale_eaje/identite"
147
+ else
148
+ raise ArgumentError, "version #{version.inspect} not available for /dss/participation_familiale_eaje/identite; supported: [3]"
149
+ end
150
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
151
+ end
152
+
153
+ # [FranceConnect] Statut prime d'activité
154
+ # Logical endpoint: /dss/prime_activite/france_connect
155
+ # Versions available: [3] — default: 3
156
+ def prime_activite(version: nil, recipient: nil)
157
+ path =
158
+ case version || 3
159
+ when 3
160
+ "/v3/dss/prime_activite/france_connect"
161
+ else
162
+ raise ArgumentError, "version #{version.inspect} not available for /dss/prime_activite/france_connect; supported: [3]"
163
+ end
164
+ @client.get(path, params: { "recipient" => recipient }.compact)
165
+ end
166
+
167
+ # [Identité] Statut prime d'activité
168
+ # Logical endpoint: /dss/prime_activite/identite
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)
171
+ path =
172
+ case version || 3
173
+ when 3
174
+ "/v3/dss/prime_activite/identite"
175
+ else
176
+ raise ArgumentError, "version #{version.inspect} not available for /dss/prime_activite/identite; supported: [3]"
177
+ end
178
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
179
+ end
180
+
181
+ # [FranceConnect] Quotient familial CAF & MSA
182
+ # Logical endpoint: /dss/quotient_familial/france_connect
183
+ # Versions available: [3] — default: 3
184
+ def quotient_familial(version: nil, recipient: nil, annee: nil, mois: nil)
185
+ path =
186
+ case version || 3
187
+ when 3
188
+ "/v3/dss/quotient_familial/france_connect"
189
+ else
190
+ raise ArgumentError, "version #{version.inspect} not available for /dss/quotient_familial/france_connect; supported: [3]"
191
+ end
192
+ @client.get(path, params: { "recipient" => recipient, "annee" => annee, "mois" => mois }.compact)
193
+ end
194
+
195
+ # [Identité] Quotient familial CAF & MSA
196
+ # Logical endpoint: /dss/quotient_familial/identite
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)
199
+ path =
200
+ case version || 3
201
+ when 3
202
+ "/v3/dss/quotient_familial/identite"
203
+ else
204
+ raise ArgumentError, "version #{version.inspect} not available for /dss/quotient_familial/identite; supported: [3]"
205
+ end
206
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance, "annee" => annee, "mois" => mois }.compact)
207
+ end
208
+
209
+ # [FranceConnect] Statut revenu de solidarité active (RSA)
210
+ # Logical endpoint: /dss/revenu_solidarite_active/france_connect
211
+ # Versions available: [3] — default: 3
212
+ def revenu_solidarite_active(version: nil, recipient: nil)
213
+ path =
214
+ case version || 3
215
+ when 3
216
+ "/v3/dss/revenu_solidarite_active/france_connect"
217
+ else
218
+ raise ArgumentError, "version #{version.inspect} not available for /dss/revenu_solidarite_active/france_connect; supported: [3]"
219
+ end
220
+ @client.get(path, params: { "recipient" => recipient }.compact)
221
+ end
222
+
223
+ # [Identité] Statut revenu de solidarité active (RSA)
224
+ # Logical endpoint: /dss/revenu_solidarite_active/identite
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)
227
+ path =
228
+ case version || 3
229
+ when 3
230
+ "/v3/dss/revenu_solidarite_active/identite"
231
+ else
232
+ raise ArgumentError, "version #{version.inspect} not available for /dss/revenu_solidarite_active/identite; supported: [3]"
233
+ end
234
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
235
+ end
236
+ end
237
+ end
238
+ end
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+ # DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
3
+ # clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
4
+ # script instead.
5
+
6
+ module ApiParticulier
7
+ module Resources
8
+ class FranceTravail
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ # Paiements versés par France Travail
14
+ # Logical endpoint: /france_travail/indemnites/identifiant
15
+ # Versions available: [3] — default: 3
16
+ def indemnites(version: nil, recipient: nil, identifiant:)
17
+ path =
18
+ case version || 3
19
+ when 3
20
+ "/v3/france_travail/indemnites/identifiant"
21
+ else
22
+ raise ArgumentError, "version #{version.inspect} not available for /france_travail/indemnites/identifiant; supported: [3]"
23
+ end
24
+ @client.get(path, params: { "recipient" => recipient, "identifiant" => identifiant }.compact)
25
+ end
26
+
27
+ # Statut demandeur d'emploi
28
+ # Logical endpoint: /france_travail/statut/identifiant
29
+ # Versions available: [3] — default: 3
30
+ def statut(version: nil, recipient: nil, identifiant:)
31
+ path =
32
+ case version || 3
33
+ when 3
34
+ "/v3/france_travail/statut/identifiant"
35
+ else
36
+ raise ArgumentError, "version #{version.inspect} not available for /france_travail/statut/identifiant; supported: [3]"
37
+ end
38
+ @client.get(path, params: { "recipient" => recipient, "identifiant" => identifiant }.compact)
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+ # DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
3
+ # clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
4
+ # script instead.
5
+
6
+ module ApiParticulier
7
+ module Resources
8
+ class GipMds
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ # [FranceConnect] Statut service civique
14
+ # Logical endpoint: /gip_mds/service_civique/france_connect
15
+ # Versions available: [3] — default: 3
16
+ def service_civique(version: nil, recipient: nil)
17
+ path =
18
+ case version || 3
19
+ when 3
20
+ "/v3/gip_mds/service_civique/france_connect"
21
+ else
22
+ raise ArgumentError, "version #{version.inspect} not available for /gip_mds/service_civique/france_connect; supported: [3]"
23
+ end
24
+ @client.get(path, params: { "recipient" => recipient }.compact)
25
+ end
26
+
27
+ # [Identité] Statut service civique
28
+ # Logical endpoint: /gip_mds/service_civique/identite
29
+ # Versions available: [3] — default: 3
30
+ def service_civique_identite(version: nil, recipient: nil, nom_naissance:, prenoms:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:)
31
+ path =
32
+ case version || 3
33
+ when 3
34
+ "/v3/gip_mds/service_civique/identite"
35
+ else
36
+ raise ArgumentError, "version #{version.inspect} not available for /gip_mds/service_civique/identite; supported: [3]"
37
+ end
38
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance }.compact)
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+ # DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
3
+ # clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
4
+ # script instead.
5
+
6
+ module ApiParticulier
7
+ module Resources
8
+ class Men
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ # Statut élève scolarisé et boursier
14
+ # Logical endpoint: /men/scolarites/identite
15
+ # Versions available: [3, 4, 5] — default: 5
16
+ def scolarites(version: nil, recipient: nil, nom_naissance:, prenoms:, sexe_etat_civil:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:, code_etablissement: nil, annee_scolaire:, degre_etablissement: nil, codes_bcn_departements: nil, codes_bcn_regions: nil)
17
+ path =
18
+ case version || 5
19
+ when 3
20
+ warn "[DEPRECATED] /v3/men/scolarites/identite (#scolarites): marked deprecated in the OpenAPI spec.", uplevel: 1
21
+ "/v3/men/scolarites/identite"
22
+ when 4
23
+ warn "[DEPRECATED] /v4/men/scolarites/identite (#scolarites): marked deprecated in the OpenAPI spec.", uplevel: 1
24
+ "/v4/men/scolarites/identite"
25
+ when 5
26
+ "/v5/men/scolarites/identite"
27
+ else
28
+ raise ArgumentError, "version #{version.inspect} not available for /men/scolarites/identite; supported: [3, 4, 5]"
29
+ end
30
+ @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "prenoms" => prenoms, "sexeEtatCivil" => sexe_etat_civil, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "codeEtablissement" => code_etablissement, "anneeScolaire" => annee_scolaire, "degreEtablissement" => degre_etablissement, "codesBcnDepartements" => codes_bcn_departements, "codesBcnRegions" => codes_bcn_regions }.compact)
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+ # DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
3
+ # clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
4
+ # script instead.
5
+
6
+ module ApiParticulier
7
+ module Resources
8
+ class Mesri
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ # [FranceConnect] Statut étudiant
14
+ # Logical endpoint: /mesri/statut_etudiant/france_connect
15
+ # Versions available: [3] — default: 3
16
+ def statut_etudiant(version: nil, recipient: nil)
17
+ path =
18
+ case version || 3
19
+ when 3
20
+ "/v3/mesri/statut_etudiant/france_connect"
21
+ else
22
+ raise ArgumentError, "version #{version.inspect} not available for /mesri/statut_etudiant/france_connect; supported: [3]"
23
+ end
24
+ @client.get(path, params: { "recipient" => recipient }.compact)
25
+ end
26
+
27
+ # [Identité] Statut étudiant
28
+ # Logical endpoint: /mesri/statut_etudiant/identite
29
+ # Versions available: [3] — default: 3
30
+ def statut_etudiant_identite(version: nil, recipient: nil, nom_naissance:, prenoms:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:, sexe_etat_civil:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
31
+ path =
32
+ case version || 3
33
+ when 3
34
+ "/v3/mesri/statut_etudiant/identite"
35
+ else
36
+ raise ArgumentError, "version #{version.inspect} not available for /mesri/statut_etudiant/identite; supported: [3]"
37
+ end
38
+ @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)
39
+ end
40
+
41
+ # [INE] Statut étudiant
42
+ # Logical endpoint: /mesri/statut_etudiant/ine
43
+ # Versions available: [3] — default: 3
44
+ def ine(version: nil, recipient: nil, ine:)
45
+ path =
46
+ case version || 3
47
+ when 3
48
+ "/v3/mesri/statut_etudiant/ine"
49
+ else
50
+ raise ArgumentError, "version #{version.inspect} not available for /mesri/statut_etudiant/ine; supported: [3]"
51
+ end
52
+ @client.get(path, params: { "recipient" => recipient, "ine" => ine }.compact)
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+ # DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
3
+ # clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
4
+ # script instead.
5
+
6
+ module ApiParticulier
7
+ module Resources
8
+ class Sdh
9
+ def initialize(client)
10
+ @client = client
11
+ end
12
+
13
+ # [Identifiant] API Statut sportif de haut niveau et sur liste ministérielle
14
+ # Logical endpoint: /sdh/statut_sportif/identifiant
15
+ # Versions available: [3] — default: 3
16
+ def statut_sportif(version: nil, recipient: nil, identifiant:)
17
+ path =
18
+ case version || 3
19
+ when 3
20
+ "/v3/sdh/statut_sportif/identifiant"
21
+ else
22
+ raise ArgumentError, "version #{version.inspect} not available for /sdh/statut_sportif/identifiant; supported: [3]"
23
+ end
24
+ @client.get(path, params: { "recipient" => recipient, "identifiant" => identifiant }.compact)
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,3 @@
1
+ module ApiParticulier
2
+ VERSION = '0.1.0'.freeze
3
+ end
@@ -0,0 +1,4 @@
1
+ require 'faraday'
2
+ require_relative 'api_particulier/version'
3
+ require_relative 'api_particulier/commons'
4
+ require_relative 'api_particulier/client'
metadata ADDED
@@ -0,0 +1,107 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: api_particulier
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - DINUM
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: faraday
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '2.0'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '2.0'
26
+ - !ruby/object:Gem::Dependency
27
+ name: faraday-retry
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - "~>"
31
+ - !ruby/object:Gem::Version
32
+ version: '2.0'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '2.0'
40
+ description: Idiomatic Ruby client for https://particulier.api.gouv.fr — auth, envelope,
41
+ error normalisation, rate limit.
42
+ email:
43
+ - api-particulier@api.gouv.fr
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - CHANGELOG.md
49
+ - LICENSE
50
+ - README.md
51
+ - lib/api_particulier.rb
52
+ - lib/api_particulier/client.rb
53
+ - lib/api_particulier/commons.rb
54
+ - lib/api_particulier/commons/auth/bearer_token.rb
55
+ - lib/api_particulier/commons/auth/strategy.rb
56
+ - lib/api_particulier/commons/client_base.rb
57
+ - lib/api_particulier/commons/configuration.rb
58
+ - lib/api_particulier/commons/errors.rb
59
+ - lib/api_particulier/commons/middleware/authentication.rb
60
+ - lib/api_particulier/commons/middleware/envelope.rb
61
+ - lib/api_particulier/commons/middleware/error_handler.rb
62
+ - lib/api_particulier/commons/middleware/logging.rb
63
+ - lib/api_particulier/commons/middleware/rate_limit.rb
64
+ - lib/api_particulier/commons/rate_limit.rb
65
+ - lib/api_particulier/commons/response.rb
66
+ - lib/api_particulier/commons/siren.rb
67
+ - lib/api_particulier/commons/siret.rb
68
+ - lib/api_particulier/commons/user_agent.rb
69
+ - lib/api_particulier/commons/version.rb
70
+ - lib/api_particulier/resources/ants.rb
71
+ - lib/api_particulier/resources/cnous.rb
72
+ - lib/api_particulier/resources/dsnj.rb
73
+ - lib/api_particulier/resources/dss.rb
74
+ - lib/api_particulier/resources/france_travail.rb
75
+ - lib/api_particulier/resources/gip_mds.rb
76
+ - lib/api_particulier/resources/men.rb
77
+ - lib/api_particulier/resources/mesri.rb
78
+ - lib/api_particulier/resources/sdh.rb
79
+ - lib/api_particulier/version.rb
80
+ homepage: https://github.com/datagouv/apistration
81
+ licenses:
82
+ - MIT
83
+ metadata:
84
+ homepage_uri: https://github.com/datagouv/apistration
85
+ source_code_uri: https://github.com/datagouv/apistration/tree/main/clients/ruby/api_particulier
86
+ changelog_uri: https://github.com/datagouv/apistration/blob/main/clients/ruby/api_particulier/CHANGELOG.md
87
+ bug_tracker_uri: https://github.com/datagouv/apistration/issues
88
+ documentation_uri: https://particulier.api.gouv.fr/v3/
89
+ rubygems_mfa_required: 'true'
90
+ rdoc_options: []
91
+ require_paths:
92
+ - lib
93
+ required_ruby_version: !ruby/object:Gem::Requirement
94
+ requirements:
95
+ - - ">="
96
+ - !ruby/object:Gem::Version
97
+ version: '3.1'
98
+ required_rubygems_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ requirements: []
104
+ rubygems_version: 3.6.9
105
+ specification_version: 4
106
+ summary: Official Ruby client for API Particulier v3
107
+ test_files: []