Class: AvalaraSdk::A1099::V2::W8BenFormResponse

Inherits:
W9FormBaseResponse show all
Defined in:
lib/avalara_sdk/models/A1099/V2/w8_ben_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 = {}) ⇒ W8BenFormResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 193

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#birthday ⇒ Object

The birthday of the individual associated with the form.



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

def birthday
  @birthday
end

#citizenship_country ⇒ Object

The country of citizenship.



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

def citizenship_country
  @citizenship_country
end

#foreign_tin ⇒ Object

The foreign taxpayer identification number (TIN).



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

def foreign_tin
  @foreign_tin
end

#foreign_tin_not_required ⇒ Object

Indicates whether a foreign TIN is not required.



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

def foreign_tin_not_required
  @foreign_tin_not_required
end

#income_type ⇒ Object

The type of income covered by the treaty.



84
85
86
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 84

def income_type
  @income_type
end

#mailing_address ⇒ Object

The mailing address.



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

def mailing_address
  @mailing_address
end

#mailing_city ⇒ Object

The city of the mailing address.



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

def mailing_city
  @mailing_city
end

#mailing_country ⇒ Object

The country of the mailing address.



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

def mailing_country
  @mailing_country
end

#mailing_state ⇒ Object

The state of the mailing address.



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

def mailing_state
  @mailing_state
end

#mailing_zip ⇒ Object

The ZIP code of the mailing address.



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

def mailing_zip
  @mailing_zip
end

#name ⇒ Object

The name of the individual or entity associated with the form.



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

def name
  @name
end

#reference_number ⇒ Object

A reference number for the form.



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

def reference_number
  @reference_number
end

#residence_address ⇒ Object

The residential address of the individual or entity.



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

def residence_address
  @residence_address
end

#residence_city ⇒ Object

The city of residence.



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

def residence_city
  @residence_city
end

#residence_country ⇒ Object

The country of residence.



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

def residence_country
  @residence_country
end

#residence_is_mailing ⇒ Object

Indicates whether the residence address is the mailing address.



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

def residence_is_mailing
  @residence_is_mailing
end

#residence_state ⇒ Object

The state of residence.



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

def residence_state
  @residence_state
end

#residence_zip ⇒ Object

The ZIP code of the residence.



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

def residence_zip
  @residence_zip
end

#signer_capacity ⇒ Object

The capacity in which the signer is signing the form.



90
91
92
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 90

def signer_capacity
  @signer_capacity
end

#signer_name ⇒ Object

The name of the signer of the form.



87
88
89
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 87

def signer_name
  @signer_name
end

#tin ⇒ Object

The taxpayer identification number (TIN).



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

def tin
  @tin
end

#tin_type ⇒ Object

The type of TIN provided.



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

def tin_type
  @tin_type
end

#treaty_article ⇒ Object

The specific article of the treaty being claimed.



75
76
77
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 75

def treaty_article
  @treaty_article
end

#treaty_country ⇒ Object

The country for which the treaty applies.



72
73
74
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 72

def treaty_country
  @treaty_country
end

#treaty_reasons ⇒ Object

The reasons for claiming treaty benefits.



78
79
80
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 78

def treaty_reasons
  @treaty_reasons
end

#withholding_rate ⇒ Object

The withholding rate applied as per the treaty.



81
82
83
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 81

def withholding_rate
  @withholding_rate
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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 402

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)



125
126
127
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 125

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.



93
94
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
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 93

def self.attribute_map
  {
    :'name' => :'name',
    :'citizenship_country' => :'citizenshipCountry',
    :'residence_address' => :'residenceAddress',
    :'residence_city' => :'residenceCity',
    :'residence_state' => :'residenceState',
    :'residence_zip' => :'residenceZip',
    :'residence_country' => :'residenceCountry',
    :'residence_is_mailing' => :'residenceIsMailing',
    :'mailing_address' => :'mailingAddress',
    :'mailing_city' => :'mailingCity',
    :'mailing_state' => :'mailingState',
    :'mailing_zip' => :'mailingZip',
    :'mailing_country' => :'mailingCountry',
    :'tin_type' => :'tinType',
    :'tin' => :'tin',
    :'foreign_tin_not_required' => :'foreignTinNotRequired',
    :'foreign_tin' => :'foreignTin',
    :'reference_number' => :'referenceNumber',
    :'birthday' => :'birthday',
    :'treaty_country' => :'treatyCountry',
    :'treaty_article' => :'treatyArticle',
    :'treaty_reasons' => :'treatyReasons',
    :'withholding_rate' => :'withholdingRate',
    :'income_type' => :'incomeType',
    :'signer_name' => :'signerName',
    :'signer_capacity' => :'signerCapacity'
  }
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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 377

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)



185
186
187
188
189
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 185

def self.openapi_all_of
  [
  :'W9FormBaseResponse'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 162

def self.openapi_nullable
  Set.new([
    :'residence_state',
    :'mailing_address',
    :'mailing_city',
    :'mailing_state',
    :'mailing_zip',
    :'mailing_country',
    :'tin_type',
    :'tin',
    :'foreign_tin',
    :'reference_number',
    :'birthday',
    :'treaty_article',
    :'treaty_reasons',
    :'withholding_rate',
    :'income_type',
    :'signer_name',
    :'signer_capacity'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 130

def self.openapi_types
  {
    :'name' => :'String',
    :'citizenship_country' => :'String',
    :'residence_address' => :'String',
    :'residence_city' => :'String',
    :'residence_state' => :'String',
    :'residence_zip' => :'String',
    :'residence_country' => :'String',
    :'residence_is_mailing' => :'Boolean',
    :'mailing_address' => :'String',
    :'mailing_city' => :'String',
    :'mailing_state' => :'String',
    :'mailing_zip' => :'String',
    :'mailing_country' => :'String',
    :'tin_type' => :'String',
    :'tin' => :'String',
    :'foreign_tin_not_required' => :'Boolean',
    :'foreign_tin' => :'String',
    :'reference_number' => :'String',
    :'birthday' => :'Date',
    :'treaty_country' => :'String',
    :'treaty_article' => :'String',
    :'treaty_reasons' => :'String',
    :'withholding_rate' => :'String',
    :'income_type' => :'String',
    :'signer_name' => :'String',
    :'signer_capacity' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      citizenship_country == o.citizenship_country &&
      residence_address == o.residence_address &&
      residence_city == o.residence_city &&
      residence_state == o.residence_state &&
      residence_zip == o.residence_zip &&
      residence_country == o.residence_country &&
      residence_is_mailing == o.residence_is_mailing &&
      mailing_address == o.mailing_address &&
      mailing_city == o.mailing_city &&
      mailing_state == o.mailing_state &&
      mailing_zip == o.mailing_zip &&
      mailing_country == o.mailing_country &&
      tin_type == o.tin_type &&
      tin == o.tin &&
      foreign_tin_not_required == o.foreign_tin_not_required &&
      foreign_tin == o.foreign_tin &&
      reference_number == o.reference_number &&
      birthday == o.birthday &&
      treaty_country == o.treaty_country &&
      treaty_article == o.treaty_article &&
      treaty_reasons == o.treaty_reasons &&
      withholding_rate == o.withholding_rate &&
      income_type == o.income_type &&
      signer_name == o.signer_name &&
      signer_capacity == o.signer_capacity && 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



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 473

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


364
365
366
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 364

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



370
371
372
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 370

def hash
  [name, citizenship_country, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, foreign_tin_not_required, foreign_tin, reference_number, birthday, treaty_country, treaty_article, treaty_reasons, withholding_rate, income_type, signer_name, signer_capacity].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



316
317
318
319
320
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 316

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



449
450
451
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 449

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



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 455

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



443
444
445
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 443

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



324
325
326
327
 
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb', line 324

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