Class: ApiParticulier::Resources::Dss

Inherits:
Object
  • Object
show all
Defined in:
lib/api_particulier/resources/dss.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Dss

Returns a new instance of Dss.



9
10
11
 
# File 'lib/api_particulier/resources/dss.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#allocation_adulte_handicape(version: nil, recipient: nil) ⇒ Object

FranceConnect

Statut allocation adulte handicapé (AAH)

Logical endpoint: /dss/allocation_adulte_handicape/france_connect Versions available: [3] — default: 3



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/api_particulier/resources/dss.rb', line 16

def allocation_adulte_handicape(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/allocation_adulte_handicape/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_adulte_handicape/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Statut allocation adulte handicapé (AAH)

Logical endpoint: /dss/allocation_adulte_handicape/identite Versions available: [3] — default: 3



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/allocation_adulte_handicape/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_adulte_handicape/identite; supported: [3]"
    end
  @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)
end

#allocation_enfant_handicape(version: nil, recipient: nil) ⇒ Object

FranceConnect

Statut allocation d’éducation de l’enfant handicapé (AEEH)

Logical endpoint: /dss/allocation_enfant_handicape/france_connect Versions available: [3] — default: 3



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/api_particulier/resources/dss.rb', line 44

def allocation_enfant_handicape(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/allocation_enfant_handicape/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_enfant_handicape/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Statut allocation d’éducation de l’enfant handicapé (AEEH)

Logical endpoint: /dss/allocation_enfant_handicape/identite Versions available: [3] — default: 3



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/allocation_enfant_handicape/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_enfant_handicape/identite; supported: [3]"
    end
  @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)
end

#allocation_soutien_familial(version: nil, recipient: nil) ⇒ Object

FranceConnect

Statut allocation de soutien familial (ASF)

Logical endpoint: /dss/allocation_soutien_familial/france_connect Versions available: [3] — default: 3



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/api_particulier/resources/dss.rb', line 72

def allocation_soutien_familial(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/allocation_soutien_familial/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_soutien_familial/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Statut allocation de soutien familial (ASF)

Logical endpoint: /dss/allocation_soutien_familial/identite Versions available: [3] — default: 3



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/allocation_soutien_familial/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_soutien_familial/identite; supported: [3]"
    end
  @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)
end

#complementaire_sante_solidaire(version: nil, recipient: nil) ⇒ Object

FranceConnect

Statut complémentaire santé solidaire (C2S)

Logical endpoint: /dss/complementaire_sante_solidaire/france_connect Versions available: [3] — default: 3



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/api_particulier/resources/dss.rb', line 100

def complementaire_sante_solidaire(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/complementaire_sante_solidaire/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/complementaire_sante_solidaire/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Statut complémentaire santé solidaire (C2S)

Logical endpoint: /dss/complementaire_sante_solidaire/identite Versions available: [3] — default: 3



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/complementaire_sante_solidaire/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/complementaire_sante_solidaire/identite; supported: [3]"
    end
  @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)
end

#participation_familiale_eaje(version: nil, recipient: nil) ⇒ Object

FranceConnect

Participation familiale EAJE

Logical endpoint: /dss/participation_familiale_eaje/france_connect Versions available: [3] — default: 3



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/api_particulier/resources/dss.rb', line 128

def participation_familiale_eaje(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/participation_familiale_eaje/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/participation_familiale_eaje/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Participation familiale EAJE

Logical endpoint: /dss/participation_familiale_eaje/identite Versions available: [3] — default: 3



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/participation_familiale_eaje/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/participation_familiale_eaje/identite; supported: [3]"
    end
  @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)
end

#prime_activite(version: nil, recipient: nil) ⇒ Object

FranceConnect

Statut prime d’activité

Logical endpoint: /dss/prime_activite/france_connect Versions available: [3] — default: 3



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/api_particulier/resources/dss.rb', line 156

def prime_activite(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/prime_activite/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/prime_activite/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Statut prime d’activité

Logical endpoint: /dss/prime_activite/identite Versions available: [3] — default: 3



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/prime_activite/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/prime_activite/identite; supported: [3]"
    end
  @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)
end

#quotient_familial(version: nil, recipient: nil, annee: nil, mois: nil) ⇒ Object

FranceConnect

Quotient familial CAF & MSA

Logical endpoint: /dss/quotient_familial/france_connect Versions available: [3] — default: 3



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/api_particulier/resources/dss.rb', line 184

def quotient_familial(version: nil, recipient: nil, annee: nil, mois: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/quotient_familial/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/quotient_familial/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient, "annee" => annee, "mois" => mois }.compact)
end

#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) ⇒ Object

Identité

Quotient familial CAF & MSA

Logical endpoint: /dss/quotient_familial/identite Versions available: [3] — default: 3



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/quotient_familial/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/quotient_familial/identite; supported: [3]"
    end
  @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)
end

#revenu_solidarite_active(version: nil, recipient: nil) ⇒ Object

FranceConnect

Statut revenu de solidarité active (RSA)

Logical endpoint: /dss/revenu_solidarite_active/france_connect Versions available: [3] — default: 3



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/api_particulier/resources/dss.rb', line 212

def revenu_solidarite_active(version: nil, recipient: nil)
  path =
    case version || 3
    when 3
    "/v3/dss/revenu_solidarite_active/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/revenu_solidarite_active/france_connect; supported: [3]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

#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) ⇒ Object

Identité

Statut revenu de solidarité active (RSA)

Logical endpoint: /dss/revenu_solidarite_active/identite Versions available: [3] — default: 3



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/api_particulier/resources/dss.rb', line 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)
  path =
    case version || 3
    when 3
    "/v3/dss/revenu_solidarite_active/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /dss/revenu_solidarite_active/identite; supported: [3]"
    end
  @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)
end