Class: AvalaraSdk::A1099::V2::FormRequestCsvBase

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormRequestCsvBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  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_name')
    self.recipient_name = attributes[:'recipient_name']
  end

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

  if attributes.key?(:'address2')
    self.address2 = attributes[:'address2']
  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?(:'recipient_email')
    self.recipient_email = attributes[:'recipient_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?(:'recipient_non_us_province')
    self.recipient_non_us_province = attributes[:'recipient_non_us_province']
  end

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

Returns the value of attribute account_number.



44
45
46
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 44

def 
  @account_number
end

#address ⇒ Object

Returns the value of attribute address.



32
33
34
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 32

def address
  @address
end

#address2 ⇒ Object

Returns the value of attribute address2.



34
35
36
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 34

def address2
  @address2
end

#address_verification ⇒ Object

Returns the value of attribute address_verification.



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

def address_verification
  @address_verification
end

#city ⇒ Object

Returns the value of attribute city.



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

def city
  @city
end

#country_code ⇒ Object

Returns the value of attribute country_code.



50
51
52
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 50

def country_code
  @country_code
end

#federal_e_file ⇒ Object

Returns the value of attribute federal_e_file.



52
53
54
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 52

def federal_e_file
  @federal_e_file
end

#issuer_id ⇒ Object

Returns the value of attribute issuer_id.



20
21
22
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 20

def issuer_id
  @issuer_id
end

#issuer_reference_id ⇒ Object

Returns the value of attribute issuer_reference_id.



14
15
16
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 14

def issuer_reference_id
  @issuer_reference_id
end

#issuer_tin ⇒ Object

Returns the value of attribute issuer_tin.



16
17
18
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 16

def issuer_tin
  @issuer_tin
end

#office_code ⇒ Object

Returns the value of attribute office_code.



46
47
48
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 46

def office_code
  @office_code
end

#postal_mail ⇒ Object

Returns the value of attribute postal_mail.



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

def postal_mail
  @postal_mail
end

#recipient_email ⇒ Object

Returns the value of attribute recipient_email.



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

def recipient_email
  @recipient_email
end

#recipient_name ⇒ Object

Returns the value of attribute recipient_name.



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

def recipient_name
  @recipient_name
end

#recipient_non_us_province ⇒ Object

Returns the value of attribute recipient_non_us_province.



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

def recipient_non_us_province
  @recipient_non_us_province
end

#recipient_second_name ⇒ Object

Returns the value of attribute recipient_second_name.



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

def recipient_second_name
  @recipient_second_name
end

#recipient_tin ⇒ Object

Returns the value of attribute recipient_tin.



26
27
28
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 26

def recipient_tin
  @recipient_tin
end

#reference_id ⇒ Object

Returns the value of attribute reference_id.



22
23
24
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 22

def reference_id
  @reference_id
end

#state ⇒ Object

Returns the value of attribute state.



38
39
40
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 38

def state
  @state
end

#state_and_local_withholding ⇒ Object

Returns the value of attribute state_and_local_withholding.



62
63
64
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 62

def state_and_local_withholding
  @state_and_local_withholding
end

#state_e_file ⇒ Object

Returns the value of attribute state_e_file.



56
57
58
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 56

def state_e_file
  @state_e_file
end

#tax_year ⇒ Object

Returns the value of attribute tax_year.



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

def tax_year
  @tax_year
end

#tin_match ⇒ Object

Returns the value of attribute tin_match.



58
59
60
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 58

def tin_match
  @tin_match
end

#tin_type ⇒ Object

Returns the value of attribute tin_type.



28
29
30
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 28

def tin_type
  @tin_type
end

#zip ⇒ Object

Returns the value of attribute zip.



40
41
42
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 40

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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 388

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



118
119
120
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 118

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 87

def self.attribute_map
  {
    :'issuer_reference_id' => :'issuerReferenceId',
    :'issuer_tin' => :'issuerTin',
    :'tax_year' => :'taxYear',
    :'issuer_id' => :'issuerId',
    :'reference_id' => :'referenceId',
    :'recipient_name' => :'recipientName',
    :'recipient_tin' => :'recipientTin',
    :'tin_type' => :'tinType',
    :'recipient_second_name' => :'recipientSecondName',
    :'address' => :'address',
    :'address2' => :'address2',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'recipient_email' => :'recipientEmail',
    :'account_number' => :'accountNumber',
    :'office_code' => :'officeCode',
    :'recipient_non_us_province' => :'recipientNonUsProvince',
    :'country_code' => :'countryCode',
    :'federal_e_file' => :'federalEFile',
    :'postal_mail' => :'postalMail',
    :'state_e_file' => :'stateEFile',
    :'tin_match' => :'tinMatch',
    :'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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 364

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



168
169
170
171
172
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 168

def self.openapi_all_of
  [
  :'FormRequestBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 154

def self.openapi_nullable
  Set.new([
    :'issuer_id',
    :'reference_id',
    :'recipient_name',
    :'address2',
    :'recipient_email',
    :'account_number',
    :'office_code',
    :'recipient_non_us_province',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'issuer_reference_id' => :'String',
    :'issuer_tin' => :'String',
    :'tax_year' => :'Integer',
    :'issuer_id' => :'String',
    :'reference_id' => :'String',
    :'recipient_name' => :'String',
    :'recipient_tin' => :'String',
    :'tin_type' => :'String',
    :'recipient_second_name' => :'String',
    :'address' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'recipient_email' => :'String',
    :'account_number' => :'String',
    :'office_code' => :'String',
    :'recipient_non_us_province' => :'String',
    :'country_code' => :'String',
    :'federal_e_file' => :'Boolean',
    :'postal_mail' => :'Boolean',
    :'state_e_file' => :'Boolean',
    :'tin_match' => :'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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      issuer_reference_id == o.issuer_reference_id &&
      issuer_tin == o.issuer_tin &&
      tax_year == o.tax_year &&
      issuer_id == o.issuer_id &&
      reference_id == o.reference_id &&
      recipient_name == o.recipient_name &&
      recipient_tin == o.recipient_tin &&
      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 &&
      recipient_email == o.recipient_email &&
       == o. &&
      office_code == o.office_code &&
      recipient_non_us_province == o.recipient_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 &&
      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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 459

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


351
352
353
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



357
358
359
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 357

def hash
  [issuer_reference_id, issuer_tin, tax_year, issuer_id, reference_id, recipient_name, recipient_tin, tin_type, recipient_second_name, address, address2, city, state, zip, recipient_email, , office_code, recipient_non_us_province, country_code, federal_e_file, postal_mail, state_e_file, tin_match, 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



292
293
294
295
296
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 292

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



435
436
437
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 441

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



429
430
431
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 429

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



300
301
302
303
304
305
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb', line 300

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)
  true
end