Class: Buildium::TaxInformationSaveMessage

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

Overview

Tax information.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaxInformationSaveMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#include_in1099 ⇒ Object

Indicates whether the vendor should be included in 1099 form generation.



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

def include_in1099
  @include_in1099
end

#tax_payer_id ⇒ Object

The unique identifier of the tax payer. Required if ‘TaxPayerType` is set. Format the values based on the `TaxPayerIdType` that is specified in the request. `SSN` must be formatted as 123-45-6789. `EIN` must be formatted as 12-3456789.



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

def tax_payer_id
  @tax_payer_id
end

#tax_payer_name1 ⇒ Object

The tax payer name 1. The value cannot exceed 40 characters.



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

def tax_payer_name1
  @tax_payer_name1
end

#tax_payer_name2 ⇒ Object

The tax payer name 2. The value cannot exceed 40 characters.



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

def tax_payer_name2
  @tax_payer_name2
end

#tax_payer_type ⇒ Object

The tax payer type. Required if ‘TaxPayerId` is set.



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

def tax_payer_type
  @tax_payer_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 59

def self.attribute_map
  {
    :'tax_payer_id' => :'TaxPayerId',
    :'tax_payer_type' => :'TaxPayerType',
    :'tax_payer_name1' => :'TaxPayerName1',
    :'tax_payer_name2' => :'TaxPayerName2',
    :'include_in1099' => :'IncludeIn1099',
    :'address' => :'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



191
192
193
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 191

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 76

def self.openapi_types
  {
    :'tax_payer_id' => :'String',
    :'tax_payer_type' => :'String',
    :'tax_payer_name1' => :'String',
    :'tax_payer_name2' => :'String',
    :'include_in1099' => :'Boolean',
    :'address' => :'SaveAddressMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tax_payer_id == o.tax_payer_id &&
      tax_payer_type == o.tax_payer_type &&
      tax_payer_name1 == o.tax_payer_name1 &&
      tax_payer_name2 == o.tax_payer_name2 &&
      include_in1099 == o.include_in1099 &&
      address == o.address
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 222

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 293

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



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

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


178
179
180
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 184

def hash
  [tax_payer_id, tax_payer_type, tax_payer_name1, tax_payer_name2, include_in1099, 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



135
136
137
138
139
140
141
142
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  if @include_in1099.nil?
    invalid_properties.push('invalid value for "include_in1099", include_in1099 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



269
270
271
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 275

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



263
264
265
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 263

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



146
147
148
149
150
151
 
# File 'lib/buildium-ruby/models/tax_information_save_message.rb', line 146

def valid?
  tax_payer_type_validator = EnumAttributeValidator.new('String', ["SSN", "EIN"])
  return false unless tax_payer_type_validator.valid?(@tax_payer_type)
  return false if @include_in1099.nil?
  true
end