Class: Buildium::UpdateVendorRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateVendorRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 121

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

The account number of the vendor. The value cannot exceed 30 characters.



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

def 
  @account_number
end

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#alternate_email ⇒ Object

Alternate email for the vendor.



34
35
36
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 34

def alternate_email
  @alternate_email
end

#category_id ⇒ Object

The unique identifier of the vendor category.



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

def category_id
  @category_id
end

#comments ⇒ Object

Comments about the vendor. The value cannot exceed 65,535 characters.



55
56
57
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 55

def comments
  @comments
end

#company_name ⇒ Object

Company name of the vendor. Required if ‘IsCompany` is `true`. The value cannot exceed 127 characters.



28
29
30
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 28

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.



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

def 
  @expense_gl_account_id
end

#first_name ⇒ Object

First name of the vendor. Required if ‘IsCompany` is `false`. The value cannot exceed 127 characters.



19
20
21
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 19

def first_name
  @first_name
end

#is_company ⇒ Object

Indicates whether the vendor should be considered a company or person.



25
26
27
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 25

def is_company
  @is_company
end

#last_name ⇒ Object

Last name of the vendor. Required if ‘IsCompany` is `false`. The value cannot exceed 127 characters.



22
23
24
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 22

def last_name
  @last_name
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



36
37
38
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 36

def phone_numbers
  @phone_numbers
end

#primary_email ⇒ Object

Primary email for the vendor.



31
32
33
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 31

def primary_email
  @primary_email
end

#tax_information ⇒ Object

Returns the value of attribute tax_information.



57
58
59
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 57

def tax_information
  @tax_information
end

#vendor_insurance ⇒ Object

Returns the value of attribute vendor_insurance.



52
53
54
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 52

def vendor_insurance
  @vendor_insurance
end

#website ⇒ Object

The website of the vendor. The value must be a valid URL. For example "www.example.com". The value cannot exceed 100 characters.



50
51
52
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 50

def website
  @website
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 60

def self.attribute_map
  {
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'is_company' => :'IsCompany',
    :'company_name' => :'CompanyName',
    :'primary_email' => :'PrimaryEmail',
    :'alternate_email' => :'AlternateEmail',
    :'phone_numbers' => :'PhoneNumbers',
    :'address' => :'Address',
    :'category_id' => :'CategoryId',
    :'expense_gl_account_id' => :'ExpenseGlAccountId',
    :'account_number' => :'AccountNumber',
    :'website' => :'Website',
    :'vendor_insurance' => :'VendorInsurance',
    :'comments' => :'Comments',
    :'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



255
256
257
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 255

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



113
114
115
116
117
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 113

def self.openapi_all_of
  [
  :'VendorPutMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 86

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'is_company' => :'Boolean',
    :'company_name' => :'String',
    :'primary_email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'VendorPostMessagePhoneNumbers',
    :'address' => :'VendorPostMessageAddress',
    :'category_id' => :'Integer',
    :'expense_gl_account_id' => :'Integer',
    :'account_number' => :'String',
    :'website' => :'String',
    :'vendor_insurance' => :'VendorPostMessageVendorInsurance',
    :'comments' => :'String',
    :'tax_information' => :'VendorPutMessageTaxInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      is_company == o.is_company &&
      company_name == o.company_name &&
      primary_email == o.primary_email &&
      alternate_email == o.alternate_email &&
      phone_numbers == o.phone_numbers &&
      address == o.address &&
      category_id == o.category_id &&
       == o. &&
       == o. &&
      website == o.website &&
      vendor_insurance == o.vendor_insurance &&
      comments == o.comments &&
      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



286
287
288
289
290
291
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
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 286

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 357

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 262

def build_from_hash(attributes)
  return nil 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


242
243
244
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [first_name, last_name, is_company, company_name, primary_email, alternate_email, phone_numbers, address, category_id, , , website, 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



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  if @is_company.nil?
    invalid_properties.push('invalid value for "is_company", is_company cannot be nil.')
  end

  if @category_id.nil?
    invalid_properties.push('invalid value for "category_id", category_id cannot be nil.')
  end

  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



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

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 339

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



327
328
329
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 327

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



212
213
214
215
216
 
# File 'lib/buildium-ruby/models/update_vendor_request.rb', line 212

def valid?
  return false if @is_company.nil?
  return false if @category_id.nil?
  true
end