Class: FactPulse::IncomingSupplier

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

Overview

Supplier extracted from an incoming invoice. Unlike the Supplier model in models.py, this model does not have a supplier_id field as this information is not available in Factur-X/CII/UBL XML files.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 89

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

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

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

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

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

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

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

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

Instance Attribute Details

#electronic_address ⇒ Object

Returns the value of attribute electronic_address.



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

def electronic_address
  @electronic_address
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#name ⇒ Object

Supplier business name (BT-27)



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

def name
  @name
end

#phone ⇒ Object

Returns the value of attribute phone.



34
35
36
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 34

def phone
  @phone
end

#postal_address ⇒ Object

Returns the value of attribute postal_address.



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

def postal_address
  @postal_address
end

#siren ⇒ Object

Returns the value of attribute siren.



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

def siren
  @siren
end

#siret ⇒ Object

Returns the value of attribute siret.



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

def siret
  @siret
end

#vat_number ⇒ Object

Returns the value of attribute vat_number.



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

def vat_number
  @vat_number
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 56

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 37

def self.attribute_map
  {
    :'name' => :'name',
    :'siren' => :'siren',
    :'siret' => :'siret',
    :'vat_number' => :'vatNumber',
    :'postal_address' => :'postalAddress',
    :'electronic_address' => :'electronicAddress',
    :'email' => :'email',
    :'phone' => :'phone'
  }
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 198

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



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 75

def self.openapi_nullable
  Set.new([
    :'siren',
    :'siret',
    :'vat_number',
    :'postal_address',
    :'electronic_address',
    :'email',
    :'phone'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 61

def self.openapi_types
  {
    :'name' => :'String',
    :'siren' => :'String',
    :'siret' => :'String',
    :'vat_number' => :'String',
    :'postal_address' => :'PostalAddress',
    :'electronic_address' => :'ElectronicAddress',
    :'email' => :'String',
    :'phone' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      siren == o.siren &&
      siret == o.siret &&
      vat_number == o.vat_number &&
      postal_address == o.postal_address &&
      electronic_address == o.electronic_address &&
      email == o.email &&
      phone == o.phone
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 191

def hash
  [name, siren, siret, vat_number, postal_address, electronic_address, email, phone].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



140
141
142
143
144
145
146
147
148
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 140

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 220

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



152
153
154
155
156
 
# File 'lib/factpulse/models/incoming_supplier.rb', line 152

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