Class: FactPulse::Beneficiaire

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

Overview

Informations sur le bénéficiaire du paiement (BG-10 / PayeeTradeParty). Le bénéficiaire est la partie qui reçoit le paiement. Ce bloc est utilisé uniquement si le bénéficiaire est différent du vendeur (fournisseur). **Cas d’usage principal** : Affacturage (factoring) Quand une facture est affacturée, le factor (société d’affacturage) devient le bénéficiaire du paiement à la place du fournisseur. **Business Terms (EN16931)** : - BT-59 : Nom du bénéficiaire (obligatoire) - BT-60 : Identifiant du bénéficiaire (SIRET avec schemeID 0009) - BT-61 : Identifiant légal du bénéficiaire (SIREN avec schemeID 0002) **Référence** : docs/guide_affacturage.md

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
 
# File 'lib/factpulse/models/beneficiaire.rb', line 79

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

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

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

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

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

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

Instance Attribute Details

#adresse_electronique ⇒ Object

Returns the value of attribute adresse_electronique.



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

def adresse_electronique
  @adresse_electronique
end

#bic ⇒ Object

Returns the value of attribute bic.



30
31
32
 
# File 'lib/factpulse/models/beneficiaire.rb', line 30

def bic
  @bic
end

#iban ⇒ Object

Returns the value of attribute iban.



28
29
30
 
# File 'lib/factpulse/models/beneficiaire.rb', line 28

def iban
  @iban
end

#nom ⇒ Object

Nom du bénéficiaire (BT-59). Obligatoire.



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

def nom
  @nom
end

#siren ⇒ Object

Returns the value of attribute siren.



24
25
26
 
# File 'lib/factpulse/models/beneficiaire.rb', line 24

def siren
  @siren
end

#siret ⇒ Object

Returns the value of attribute siret.



22
23
24
 
# File 'lib/factpulse/models/beneficiaire.rb', line 22

def siret
  @siret
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/factpulse/models/beneficiaire.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/factpulse/models/beneficiaire.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'nom' => :'nom',
    :'siret' => :'siret',
    :'siren' => :'siren',
    :'adresse_electronique' => :'adresseElectronique',
    :'iban' => :'iban',
    :'bic' => :'bic'
  }
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/beneficiaire.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
71
72
73
74
75
 
# File 'lib/factpulse/models/beneficiaire.rb', line 67

def self.openapi_nullable
  Set.new([
    :'siret',
    :'siren',
    :'adresse_electronique',
    :'iban',
    :'bic'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'nom' => :'String',
    :'siret' => :'String',
    :'siren' => :'String',
    :'adresse_electronique' => :'AdresseElectronique',
    :'iban' => :'String',
    :'bic' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


208
209
210
 
# File 'lib/factpulse/models/beneficiaire.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/beneficiaire.rb', line 214

def hash
  [nom, siret, siren, adresse_electronique, iban, bic].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



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

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

  if @nom.to_s.length < 1
    invalid_properties.push('invalid value for "nom", the character length must be greater than or equal to 1.')
  end

  pattern = Regexp.new(/^\d{14}$/)
  if !@siret.nil? && @siret !~ pattern
    invalid_properties.push("invalid value for \"siret\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d{9}$/)
  if !@siren.nil? && @siren !~ pattern
    invalid_properties.push("invalid value for \"siren\", must conform to the pattern #{pattern}.")
  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/beneficiaire.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



148
149
150
151
152
153
154
155
 
# File 'lib/factpulse/models/beneficiaire.rb', line 148

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @nom.nil?
  return false if @nom.to_s.length < 1
  return false if !@siret.nil? && @siret !~ Regexp.new(/^\d{14}$/)
  return false if !@siren.nil? && @siren !~ Regexp.new(/^\d{9}$/)
  true
end