Class: AvalaraSdk::A1099::V2::W4FormResponse

Inherits:
W9FormBaseResponse show all
Defined in:
lib/avalara_sdk/models/A1099/V2/w4_form_response.rb

Instance Attribute Summary collapse

Attributes inherited from W9FormBaseResponse

#ancestor_id, #archived, #company_id, #created_at, #display_name, #e_delivery_consented_at, #email, #entry_status, #id, #reference_id, #signature, #signed_date, #type, #updated_at

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from W9FormBaseResponse

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ W4FormResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 154

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::W4FormResponse` 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 `AvalaraSdk::A1099::V2::W4FormResponse`. 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
  }

  # call parent's initialize
  super(attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_withheld ⇒ Object

The additional amount withheld.



63
64
65
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 63

def additional_withheld
  @additional_withheld
end

#address ⇒ Object

The address of the employee.



33
34
35
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 33

def address
  @address
end

#city ⇒ Object

The city of residence of the employee.



36
37
38
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 36

def city
  @city
end

#deductions ⇒ Object

The amount of deductions claimed.



60
61
62
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 60

def deductions
  @deductions
end

#employee_first_name ⇒ Object

The first name of the employee.



15
16
17
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 15

def employee_first_name
  @employee_first_name
end

#employee_last_name ⇒ Object

The last name of the employee.



21
22
23
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 21

def employee_last_name
  @employee_last_name
end

#employee_middle_name ⇒ Object

The middle name of the employee.



18
19
20
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 18

def employee_middle_name
  @employee_middle_name
end

#employee_name_suffix ⇒ Object

The name suffix of the employee.



24
25
26
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 24

def employee_name_suffix
  @employee_name_suffix
end

#exempt_from_withholding ⇒ Object

Indicates whether the employee is exempt from withholding.



66
67
68
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 66

def exempt_from_withholding
  @exempt_from_withholding
end

#last_name_differs ⇒ Object

Indicates whether the last name differs from prior records.



48
49
50
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 48

def last_name_differs
  @last_name_differs
end

#marital_status ⇒ Object

The marital status of the employee.



45
46
47
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 45

def marital_status
  @marital_status
end

#non_job_income ⇒ Object

The amount of non-job income.



57
58
59
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 57

def non_job_income
  @non_job_income
end

#num_allowances ⇒ Object

The number of allowances claimed by the employee.



51
52
53
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 51

def num_allowances
  @num_allowances
end

#office_code ⇒ Object

The office code associated with the form.



69
70
71
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 69

def office_code
  @office_code
end

#other_dependents ⇒ Object

The number of dependents other than allowances.



54
55
56
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 54

def other_dependents
  @other_dependents
end

#state ⇒ Object

The state of residence of the employee.



39
40
41
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 39

def state
  @state
end

#tin ⇒ Object

The taxpayer identification number (TIN).



30
31
32
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 30

def tin
  @tin
end

#tin_type ⇒ Object

The type of TIN provided.



27
28
29
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 27

def tin_type
  @tin_type
end

#zip ⇒ Object

The ZIP code of residence of the employee.



42
43
44
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 42

def zip
  @zip
end

Class Method Details

._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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 328

def self._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 = AvalaraSdk::A1099::V2.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



97
98
99
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 97

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 72

def self.attribute_map
  {
    :'employee_first_name' => :'employeeFirstName',
    :'employee_middle_name' => :'employeeMiddleName',
    :'employee_last_name' => :'employeeLastName',
    :'employee_name_suffix' => :'employeeNameSuffix',
    :'tin_type' => :'tinType',
    :'tin' => :'tin',
    :'address' => :'address',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'marital_status' => :'maritalStatus',
    :'last_name_differs' => :'lastNameDiffers',
    :'num_allowances' => :'numAllowances',
    :'other_dependents' => :'otherDependents',
    :'non_job_income' => :'nonJobIncome',
    :'deductions' => :'deductions',
    :'additional_withheld' => :'additionalWithheld',
    :'exempt_from_withholding' => :'exemptFromWithholding',
    :'office_code' => :'officeCode'
  }
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 303

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



146
147
148
149
150
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 146

def self.openapi_all_of
  [
  :'W9FormBaseResponse'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 127

def self.openapi_nullable
  Set.new([
    :'employee_middle_name',
    :'employee_name_suffix',
    :'address',
    :'city',
    :'state',
    :'zip',
    :'marital_status',
    :'num_allowances',
    :'other_dependents',
    :'non_job_income',
    :'deductions',
    :'additional_withheld',
    :'office_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 102

def self.openapi_types
  {
    :'employee_first_name' => :'String',
    :'employee_middle_name' => :'String',
    :'employee_last_name' => :'String',
    :'employee_name_suffix' => :'String',
    :'tin_type' => :'String',
    :'tin' => :'String',
    :'address' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'marital_status' => :'String',
    :'last_name_differs' => :'Boolean',
    :'num_allowances' => :'Integer',
    :'other_dependents' => :'Integer',
    :'non_job_income' => :'Float',
    :'deductions' => :'Float',
    :'additional_withheld' => :'Float',
    :'exempt_from_withholding' => :'Boolean',
    :'office_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employee_first_name == o.employee_first_name &&
      employee_middle_name == o.employee_middle_name &&
      employee_last_name == o.employee_last_name &&
      employee_name_suffix == o.employee_name_suffix &&
      tin_type == o.tin_type &&
      tin == o.tin &&
      address == o.address &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      marital_status == o.marital_status &&
      last_name_differs == o.last_name_differs &&
      num_allowances == o.num_allowances &&
      other_dependents == o.other_dependents &&
      non_job_income == o.non_job_income &&
      deductions == o.deductions &&
      additional_withheld == o.additional_withheld &&
      exempt_from_withholding == o.exempt_from_withholding &&
      office_code == o.office_code && super(o)
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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 399

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


290
291
292
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 290

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



296
297
298
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 296

def hash
  [employee_first_name, employee_middle_name, employee_last_name, employee_name_suffix, tin_type, tin, address, city, state, zip, marital_status, last_name_differs, num_allowances, other_dependents, non_job_income, deductions, additional_withheld, exempt_from_withholding, office_code].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



249
250
251
252
253
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 249

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = super
  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



375
376
377
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 381

def to_hash
  hash = super
  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



369
370
371
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 369

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



257
258
259
260
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_response.rb', line 257

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true && super
end