Class: FactPulse::ChorusProCredentials

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/chorus_pro_credentials.rb

Overview

Credentials Chorus Pro pour mode Zero-Trust. **Mode Zero-Trust** : Les credentials sont passés dans chaque requête et ne sont JAMAIS stockés. **Sécurité** : - Les credentials ne sont jamais persistés dans la base de données - Ils sont utilisés uniquement pour la durée de la requête - Transmission sécurisée via HTTPS **Cas d’usage** : - Environnements à haute sécurité (banques, administrations) - Conformité RGPD stricte - Tests avec credentials temporaires - Utilisateurs ne voulant pas stocker leurs credentials

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ChorusProCredentials

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::ChorusProCredentials` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::ChorusProCredentials`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'piste_client_id')
    self.piste_client_id = attributes[:'piste_client_id']
  else
    self.piste_client_id = nil
  end

  if attributes.key?(:'piste_client_secret')
    self.piste_client_secret = attributes[:'piste_client_secret']
  else
    self.piste_client_secret = nil
  end

  if attributes.key?(:'chorus_pro_login')
    self. = attributes[:'chorus_pro_login']
  else
    self. = nil
  end

  if attributes.key?(:'chorus_pro_password')
    self.chorus_pro_password = attributes[:'chorus_pro_password']
  else
    self.chorus_pro_password = nil
  end

  if attributes.key?(:'sandbox')
    self.sandbox = attributes[:'sandbox']
  else
    self.sandbox = true
  end
end

Instance Attribute Details

#chorus_pro_login ⇒ Object

Login Chorus Pro



26
27
28
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 26

def 
  @chorus_pro_login
end

#chorus_pro_password ⇒ Object

Mot de passe Chorus Pro



29
30
31
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 29

def chorus_pro_password
  @chorus_pro_password
end

#piste_client_id ⇒ Object

Client ID PISTE (portail API gouvernement)



20
21
22
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 20

def piste_client_id
  @piste_client_id
end

#piste_client_secret ⇒ Object

Client Secret PISTE



23
24
25
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 23

def piste_client_secret
  @piste_client_secret
end

#sandbox ⇒ Object

Utiliser l’environnement sandbox (true) ou production (false)



32
33
34
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 32

def sandbox
  @sandbox
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 35

def self.attribute_map
  {
    :'piste_client_id' => :'piste_client_id',
    :'piste_client_secret' => :'piste_client_secret',
    :'chorus_pro_login' => :'chorus_pro_login',
    :'chorus_pro_password' => :'chorus_pro_password',
    :'sandbox' => :'sandbox'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 221

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 67

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 56

def self.openapi_types
  {
    :'piste_client_id' => :'String',
    :'piste_client_secret' => :'String',
    :'chorus_pro_login' => :'String',
    :'chorus_pro_password' => :'String',
    :'sandbox' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      piste_client_id == o.piste_client_id &&
      piste_client_secret == o.piste_client_secret &&
       == o. &&
      chorus_pro_password == o.chorus_pro_password &&
      sandbox == o.sandbox
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


208
209
210
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 214

def hash
  [piste_client_id, piste_client_secret, , chorus_pro_password, sandbox].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 121

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @piste_client_id.nil?
    invalid_properties.push('invalid value for "piste_client_id", piste_client_id cannot be nil.')
  end

  if @piste_client_secret.nil?
    invalid_properties.push('invalid value for "piste_client_secret", piste_client_secret cannot be nil.')
  end

  if @chorus_pro_login.nil?
    invalid_properties.push('invalid value for "chorus_pro_login", chorus_pro_login cannot be nil.')
  end

  if @chorus_pro_password.nil?
    invalid_properties.push('invalid value for "chorus_pro_password", chorus_pro_password cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 243

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



145
146
147
148
149
150
151
152
 
# File 'lib/factpulse/models/chorus_pro_credentials.rb', line 145

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @piste_client_id.nil?
  return false if @piste_client_secret.nil?
  return false if @chorus_pro_login.nil?
  return false if @chorus_pro_password.nil?
  true
end