Class: ApiParticulier::Resources::Cnous

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Cnous

Returns a new instance of Cnous.



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

def initialize(client)
  @client = client
end

Instance Method Details

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

FranceConnect

Statut étudiant boursier

Logical endpoint: /cnous/etudiant_boursier/france_connect Versions available: [3, 4] — default: 4



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

def etudiant_boursier(version: nil, recipient: nil)
  path =
    case version || 4
    when 3
    warn "[DEPRECATED] /v3/cnous/etudiant_boursier/france_connect (#etudiant_boursier): marked deprecated in the OpenAPI spec.", uplevel: 1
    "/v3/cnous/etudiant_boursier/france_connect"
    when 4
    "/v4/cnous/etudiant_boursier/france_connect"
    else
      raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/france_connect; supported: [3, 4]"
    end
  @client.get(path, params: { "recipient" => recipient }.compact)
end

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

Identité

Statut étudiant boursier

Logical endpoint: /cnous/etudiant_boursier/identite Versions available: [3, 4] — default: 4



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/api_particulier/resources/cnous.rb', line 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)
  path =
    case version || 4
    when 3
    warn "[DEPRECATED] /v3/cnous/etudiant_boursier/identite (#etudiant_boursier_identite): marked deprecated in the OpenAPI spec.", uplevel: 1
    "/v3/cnous/etudiant_boursier/identite"
    when 4
    "/v4/cnous/etudiant_boursier/identite"
    else
      raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/identite; supported: [3, 4]"
    end
  @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)
end

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

INE

Statut étudiant boursier

Logical endpoint: /cnous/etudiant_boursier/ine Versions available: [3, 4] — default: 4



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/api_particulier/resources/cnous.rb', line 50

def ine(version: nil, recipient: nil, ine:)
  path =
    case version || 4
    when 3
    warn "[DEPRECATED] /v3/cnous/etudiant_boursier/ine (#ine): marked deprecated in the OpenAPI spec.", uplevel: 1
    "/v3/cnous/etudiant_boursier/ine"
    when 4
    "/v4/cnous/etudiant_boursier/ine"
    else
      raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/ine; supported: [3, 4]"
    end
  @client.get(path, params: { "recipient" => recipient, "ine" => ine }.compact)
end