Class: AvalaraSdk::A1099::V2::FormRequestBase

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/models/A1099/V2/form_request_base.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormRequestBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'country_code')
    self.country_code = attributes[:'country_code']
  else
    self.country_code = nil
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Account number



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

def 
  @account_number
end

#address ⇒ Object

Address



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

def address
  @address
end

#address2 ⇒ Object

Address line 2



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

def address2
  @address2
end

#address_verification ⇒ Object

Boolean indicating that address verification should be scheduled for this form



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

def address_verification
  @address_verification
end

#city ⇒ Object

City



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

def city
  @city
end

#country_code ⇒ Object

Country code, as defined at www.irs.gov/e-file-providers/country-codes



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

def country_code
  @country_code
end

#email ⇒ Object

Recipient email address



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

def email
  @email
end

#federal_e_file ⇒ Object

Boolean indicating that federal e-filing should be scheduled for this form



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

def federal_e_file
  @federal_e_file
end

#issuer_id ⇒ Object

Issuer ID



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

def issuer_id
  @issuer_id
end

#no_tin ⇒ Object

Indicates whether the recipient has no TIN



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

def no_tin
  @no_tin
end

#non_us_province ⇒ Object

Foreign province



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

def non_us_province
  @non_us_province
end

#office_code ⇒ Object

Office code



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

def office_code
  @office_code
end

#postal_mail ⇒ Object

Boolean indicating that postal mailing to the recipient should be scheduled for this form



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

def postal_mail
  @postal_mail
end

#recipient_name ⇒ Object

Recipient name



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

def recipient_name
  @recipient_name
end

#recipient_second_name ⇒ Object

Recipient second name



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

def recipient_second_name
  @recipient_second_name
end

#recipient_tin ⇒ Object

Recipient Tax ID Number



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

def recipient_tin
  @recipient_tin
end

#reference_id ⇒ Object

Reference ID



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

def reference_id
  @reference_id
end

#second_tin_notice ⇒ Object

Second TIN notice in three years



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

def second_tin_notice
  @second_tin_notice
end

#state ⇒ Object

US state. Required if CountryCode is "US".



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

def state
  @state
end

#state_and_local_withholding ⇒ Object

State and local withholding information



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

def state_and_local_withholding
  @state_and_local_withholding
end

#state_e_file ⇒ Object

Boolean indicating that state e-filing should be scheduled for this form



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

def state_e_file
  @state_e_file
end

#tin_match ⇒ Object

Boolean indicating that TIN Matching should be scheduled for this form



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

def tin_match
  @tin_match
end

#tin_type ⇒ Object

Type of TIN (Tax ID Number). Will be one of: * SSN * EIN * ITIN * ATIN



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

def tin_type
  @tin_type
end

#zip ⇒ Object

Zip/postal code



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

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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 477

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



139
140
141
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 139

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 109

def self.attribute_map
  {
    :'issuer_id' => :'issuerId',
    :'reference_id' => :'referenceId',
    :'recipient_tin' => :'recipientTin',
    :'recipient_name' => :'recipientName',
    :'tin_type' => :'tinType',
    :'recipient_second_name' => :'recipientSecondName',
    :'address' => :'address',
    :'address2' => :'address2',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'email' => :'email',
    :'account_number' => :'accountNumber',
    :'office_code' => :'officeCode',
    :'non_us_province' => :'nonUsProvince',
    :'country_code' => :'countryCode',
    :'federal_e_file' => :'federalEFile',
    :'postal_mail' => :'postalMail',
    :'state_e_file' => :'stateEFile',
    :'tin_match' => :'tinMatch',
    :'no_tin' => :'noTin',
    :'second_tin_notice' => :'secondTinNotice',
    :'address_verification' => :'addressVerification',
    :'state_and_local_withholding' => :'stateAndLocalWithholding'
  }
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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 453

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

List of attributes with nullable: true



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 174

def self.openapi_nullable
  Set.new([
    :'issuer_id',
    :'reference_id',
    :'recipient_name',
    :'recipient_second_name',
    :'address2',
    :'email',
    :'account_number',
    :'office_code',
    :'non_us_province',
    :'second_tin_notice',
    :'state_and_local_withholding'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'issuer_id' => :'String',
    :'reference_id' => :'String',
    :'recipient_tin' => :'String',
    :'recipient_name' => :'String',
    :'tin_type' => :'String',
    :'recipient_second_name' => :'String',
    :'address' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'email' => :'String',
    :'account_number' => :'String',
    :'office_code' => :'String',
    :'non_us_province' => :'String',
    :'country_code' => :'String',
    :'federal_e_file' => :'Boolean',
    :'postal_mail' => :'Boolean',
    :'state_e_file' => :'Boolean',
    :'tin_match' => :'Boolean',
    :'no_tin' => :'Boolean',
    :'second_tin_notice' => :'Boolean',
    :'address_verification' => :'Boolean',
    :'state_and_local_withholding' => :'StateAndLocalWithholdingRequest'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      issuer_id == o.issuer_id &&
      reference_id == o.reference_id &&
      recipient_tin == o.recipient_tin &&
      recipient_name == o.recipient_name &&
      tin_type == o.tin_type &&
      recipient_second_name == o.recipient_second_name &&
      address == o.address &&
      address2 == o.address2 &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      email == o.email &&
       == o. &&
      office_code == o.office_code &&
      non_us_province == o.non_us_province &&
      country_code == o.country_code &&
      federal_e_file == o.federal_e_file &&
      postal_mail == o.postal_mail &&
      state_e_file == o.state_e_file &&
      tin_match == o.tin_match &&
      no_tin == o.no_tin &&
      second_tin_notice == o.second_tin_notice &&
      address_verification == o.address_verification &&
      state_and_local_withholding == o.state_and_local_withholding
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



548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 548

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


440
441
442
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 440

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



446
447
448
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 446

def hash
  [issuer_id, reference_id, recipient_tin, recipient_name, tin_type, recipient_second_name, address, address2, city, state, zip, email, , office_code, non_us_province, country_code, federal_e_file, postal_mail, state_e_file, tin_match, no_tin, second_tin_notice, address_verification, state_and_local_withholding].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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 310

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

  if @address.to_s.length < 1
    invalid_properties.push('invalid value for "address", the character length must be great than or equal to 1.')
  end

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

  if @city.to_s.length < 1
    invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
  end

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

  if @country_code.to_s.length < 1
    invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 1.')
  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



524
525
526
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 524

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 530

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



518
519
520
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 518

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



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_base.rb', line 342

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"])
  return false unless tin_type_validator.valid?(@tin_type)
  return false if @address.nil?
  return false if @address.to_s.length < 1
  return false if @city.nil?
  return false if @city.to_s.length < 1
  return false if @country_code.nil?
  return false if @country_code.to_s.length < 1
  true
end