Class: FactPulse::Supplier

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

Overview

Information about the supplier who issues the invoice.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/factpulse/models/supplier.rb', line 98

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

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

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  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?(:'iban')
    self.iban = attributes[:'iban']
  end

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

Instance Attribute Details

#electronic_address ⇒ Object

Returns the value of attribute electronic_address.



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

def electronic_address
  @electronic_address
end

#iban ⇒ Object

Returns the value of attribute iban.



35
36
37
 
# File 'lib/factpulse/models/supplier.rb', line 35

def iban
  @iban
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#postal_address ⇒ Object

Returns the value of attribute postal_address.



37
38
39
 
# File 'lib/factpulse/models/supplier.rb', line 37

def postal_address
  @postal_address
end

#siren ⇒ Object

Returns the value of attribute siren.



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

def siren
  @siren
end

#siret ⇒ Object

Returns the value of attribute siret.



31
32
33
 
# File 'lib/factpulse/models/supplier.rb', line 31

def siret
  @siret
end

#supplier_bank_account_code ⇒ Object

Returns the value of attribute supplier_bank_account_code.



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

def 
  @supplier_bank_account_code
end

#supplier_id ⇒ Object

Returns the value of attribute supplier_id.



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

def supplier_id
  @supplier_id
end

#supplier_service_id ⇒ Object

Returns the value of attribute supplier_service_id.



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

def supplier_service_id
  @supplier_service_id
end

#vat_number ⇒ Object

Returns the value of attribute vat_number.



33
34
35
 
# File 'lib/factpulse/models/supplier.rb', line 33

def vat_number
  @vat_number
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/factpulse/models/supplier.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/factpulse/models/supplier.rb', line 40

def self.attribute_map
  {
    :'electronic_address' => :'electronic_address',
    :'supplier_id' => :'supplier_id',
    :'supplier_bank_account_code' => :'supplier_bank_account_code',
    :'supplier_service_id' => :'supplier_service_id',
    :'name' => :'name',
    :'siren' => :'siren',
    :'siret' => :'siret',
    :'vat_number' => :'vat_number',
    :'iban' => :'iban',
    :'postal_address' => :'postal_address'
  }
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



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

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



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/factpulse/models/supplier.rb', line 82

def self.openapi_nullable
  Set.new([
    :'electronic_address',
    :'supplier_bank_account_code',
    :'supplier_service_id',
    :'name',
    :'siren',
    :'siret',
    :'vat_number',
    :'iban',
    :'postal_address'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/factpulse/models/supplier.rb', line 66

def self.openapi_types
  {
    :'electronic_address' => :'ElectronicAddress',
    :'supplier_id' => :'Integer',
    :'supplier_bank_account_code' => :'Integer',
    :'supplier_service_id' => :'Integer',
    :'name' => :'String',
    :'siren' => :'String',
    :'siret' => :'String',
    :'vat_number' => :'String',
    :'iban' => :'String',
    :'postal_address' => :'PostalAddress'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/factpulse/models/supplier.rb', line 189

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/factpulse/models/supplier.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/factpulse/models/supplier.rb', line 212

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



159
160
161
162
163
164
165
166
167
 
# File 'lib/factpulse/models/supplier.rb', line 159

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/factpulse/models/supplier.rb', line 241

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



171
172
173
174
175
 
# File 'lib/factpulse/models/supplier.rb', line 171

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