Class: Buildium::VendorMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/vendor_message.rb

Overview

This is an object that represents a vendor.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VendorMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 125

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'phone_numbers')
    if (value = attributes[:'phone_numbers']).is_a?(Array)
      self.phone_numbers = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Vendor account number.



59
60
61
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 59

def 
  @account_number
end

#address ⇒ Object

Returns the value of attribute address.



51
52
53
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 51

def address
  @address
end

#alternate_email ⇒ Object

Alternate email for the vendor.



38
39
40
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 38

def alternate_email
  @alternate_email
end

#category ⇒ Object

Returns the value of attribute category.



49
50
51
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 49

def category
  @category
end

#comments ⇒ Object

General comments about the vendor.



56
57
58
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 56

def comments
  @comments
end

#company_name ⇒ Object

Company name for the vendor. Empty if ‘IsCompany` is `false`



41
42
43
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 41

def company_name
  @company_name
end

#expense_gl_account_id ⇒ Object

The unique identifier of the default expense general ledger account to associate with the vendor.



62
63
64
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 62

def 
  @expense_gl_account_id
end

#first_name ⇒ Object

First name of the vendor. Empty if ‘IsCompany` is `true`.



29
30
31
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 29

def first_name
  @first_name
end

#id ⇒ Object

Vendor unique identifier.



20
21
22
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 20

def id
  @id
end

#is_active ⇒ Object

Indicates whether the vendor is active within the Buildium platform.



26
27
28
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 26

def is_active
  @is_active
end

#is_company ⇒ Object

Indicates whether the vendor is a company.



23
24
25
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 23

def is_company
  @is_company
end

#last_name ⇒ Object

Last name of the vendor. Empty if ‘IsCompany` is `true`.



32
33
34
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 32

def last_name
  @last_name
end

#phone_numbers ⇒ Object

List of phone numbers for the vendor.



44
45
46
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 44

def phone_numbers
  @phone_numbers
end

#primary_email ⇒ Object

Primary email for the vendor.



35
36
37
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 35

def primary_email
  @primary_email
end

#tax_information ⇒ Object

Returns the value of attribute tax_information.



64
65
66
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 64

def tax_information
  @tax_information
end

#vendor_insurance ⇒ Object

Returns the value of attribute vendor_insurance.



53
54
55
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 53

def vendor_insurance
  @vendor_insurance
end

#website ⇒ Object

Website of the vendor.



47
48
49
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 47

def website
  @website
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 67

def self.attribute_map
  {
    :'id' => :'Id',
    :'is_company' => :'IsCompany',
    :'is_active' => :'IsActive',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'primary_email' => :'PrimaryEmail',
    :'alternate_email' => :'AlternateEmail',
    :'company_name' => :'CompanyName',
    :'phone_numbers' => :'PhoneNumbers',
    :'website' => :'Website',
    :'category' => :'Category',
    :'address' => :'Address',
    :'vendor_insurance' => :'VendorInsurance',
    :'comments' => :'Comments',
    :'account_number' => :'AccountNumber',
    :'expense_gl_account_id' => :'ExpenseGLAccountId',
    :'tax_information' => :'TaxInformation'
  }
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



261
262
263
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 261

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 95

def self.openapi_types
  {
    :'id' => :'Integer',
    :'is_company' => :'Boolean',
    :'is_active' => :'Boolean',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'primary_email' => :'String',
    :'alternate_email' => :'String',
    :'company_name' => :'String',
    :'phone_numbers' => :'Array<PhoneNumberMessage>',
    :'website' => :'String',
    :'category' => :'LookupMessage',
    :'address' => :'AddressMessage',
    :'vendor_insurance' => :'VendorInsuranceMessage',
    :'comments' => :'String',
    :'account_number' => :'String',
    :'expense_gl_account_id' => :'Integer',
    :'tax_information' => :'VendorTaxInformationMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      is_company == o.is_company &&
      is_active == o.is_active &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      primary_email == o.primary_email &&
      alternate_email == o.alternate_email &&
      company_name == o.company_name &&
      phone_numbers == o.phone_numbers &&
      website == o.website &&
      category == o.category &&
      address == o.address &&
      vendor_insurance == o.vendor_insurance &&
      comments == o.comments &&
       == o. &&
       == o. &&
      tax_information == o.tax_information
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 292

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Buildium.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 363

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 268

def build_from_hash(attributes)
  return unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


248
249
250
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 254

def hash
  [id, is_company, is_active, first_name, last_name, primary_email, alternate_email, company_name, phone_numbers, website, category, address, vendor_insurance, comments, , , tax_information].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



211
212
213
214
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 211

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



339
340
341
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 339

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 345

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



333
334
335
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 333

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



218
219
220
 
# File 'lib/buildium-ruby/models/vendor_message.rb', line 218

def valid?
  true
end