Class: FactPulse::Destinataire

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

Overview

Informations sur le destinataire de la facture (le client).

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 = {}) ⇒ Destinataire

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/destinataire.rb', line 78

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::Destinataire` 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::Destinataire`. 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?(:'adresse_electronique')
    self.adresse_electronique = attributes[:'adresse_electronique']
  else
    self.adresse_electronique = nil
  end

  if attributes.key?(:'code_service_executant')
    self.code_service_executant = attributes[:'code_service_executant']
  end

  if attributes.key?(:'nom')
    self.nom = attributes[:'nom']
  end

  if attributes.key?(:'siren')
    self.siren = attributes[:'siren']
  end

  if attributes.key?(:'siret')
    self.siret = attributes[:'siret']
  end

  if attributes.key?(:'adresse_postale')
    self.adresse_postale = attributes[:'adresse_postale']
  end
end

Instance Attribute Details

#adresse_electroniqueObject

Returns the value of attribute adresse_electronique.



19
20
21
# File 'lib/factpulse/models/destinataire.rb', line 19

def adresse_electronique
  @adresse_electronique
end

#adresse_postaleObject

Returns the value of attribute adresse_postale.



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

def adresse_postale
  @adresse_postale
end

#code_service_executantObject

Returns the value of attribute code_service_executant.



21
22
23
# File 'lib/factpulse/models/destinataire.rb', line 21

def code_service_executant
  @code_service_executant
end

#nomObject

Returns the value of attribute nom.



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

def nom
  @nom
end

#sirenObject

Returns the value of attribute siren.



25
26
27
# File 'lib/factpulse/models/destinataire.rb', line 25

def siren
  @siren
end

#siretObject

Returns the value of attribute siret.



27
28
29
# File 'lib/factpulse/models/destinataire.rb', line 27

def siret
  @siret
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



44
45
46
# File 'lib/factpulse/models/destinataire.rb', line 44

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



49
50
51
# File 'lib/factpulse/models/destinataire.rb', line 49

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



32
33
34
35
36
37
38
39
40
41
# File 'lib/factpulse/models/destinataire.rb', line 32

def self.attribute_map
  {
    :'adresse_electronique' => :'adresseElectronique',
    :'code_service_executant' => :'codeServiceExecutant',
    :'nom' => :'nom',
    :'siren' => :'siren',
    :'siret' => :'siret',
    :'adresse_postale' => :'adressePostale'
  }
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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/factpulse/models/destinataire.rb', line 177

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_nullableObject

List of attributes with nullable: true



66
67
68
69
70
71
72
73
74
# File 'lib/factpulse/models/destinataire.rb', line 66

def self.openapi_nullable
  Set.new([
    :'code_service_executant',
    :'nom',
    :'siren',
    :'siret',
    :'adresse_postale'
  ])
end

.openapi_typesObject

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
# File 'lib/factpulse/models/destinataire.rb', line 54

def self.openapi_types
  {
    :'adresse_electronique' => :'AdresseElectronique',
    :'code_service_executant' => :'String',
    :'nom' => :'String',
    :'siren' => :'String',
    :'siret' => :'String',
    :'adresse_postale' => :'AdressePostale'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



151
152
153
154
155
156
157
158
159
160
# File 'lib/factpulse/models/destinataire.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      adresse_electronique == o.adresse_electronique &&
      code_service_executant == o.code_service_executant &&
      nom == o.nom &&
      siren == o.siren &&
      siret == o.siret &&
      adresse_postale == o.adresse_postale
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


164
165
166
# File 'lib/factpulse/models/destinataire.rb', line 164

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



170
171
172
# File 'lib/factpulse/models/destinataire.rb', line 170

def hash
  [adresse_electronique, code_service_executant, nom, siren, siret, adresse_postale].hash
end

#list_invalid_propertiesObject

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
# File 'lib/factpulse/models/destinataire.rb', line 121

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

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/factpulse/models/destinataire.rb', line 199

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



133
134
135
136
137
# File 'lib/factpulse/models/destinataire.rb', line 133

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