Class: AvalaraSdk::A1099::V2::FormResponseBase

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormResponseBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



115
116
117
118
119
120
121
122
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
152
153
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
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 115

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

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

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

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

  if attributes.key?(:'street_address_line2')
    self.street_address_line2 = attributes[:'street_address_line2']
  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
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_response_base.rb', line 44

def 
  @account_number
end

#city ⇒ Object

Returns the value of attribute city.



36
37
38
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_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_response_base.rb', line 50

def country_code
  @country_code
end

#federal_id_type ⇒ Object

Returns the value of attribute federal_id_type.



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

def federal_id_type
  @federal_id_type
end

#issuer_id ⇒ Object

Returns the value of attribute issuer_id.



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

def issuer_id
  @issuer_id
end

#issuer_reference_id ⇒ Object

Returns the value of attribute issuer_reference_id.



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

def issuer_reference_id
  @issuer_reference_id
end

#issuer_tin ⇒ Object

Returns the value of attribute issuer_tin.



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

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_response_base.rb', line 46

def office_code
  @office_code
end

#recipient_email ⇒ Object

Returns the value of attribute recipient_email.



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

def recipient_email
  @recipient_email
end

#recipient_federal_id ⇒ Object

Returns the value of attribute recipient_federal_id.



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

def recipient_federal_id
  @recipient_federal_id
end

#recipient_name ⇒ Object

Returns the value of attribute recipient_name.



24
25
26
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_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_response_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_response_base.rb', line 30

def recipient_second_name
  @recipient_second_name
end

#reference_id ⇒ Object

Returns the value of attribute reference_id.



22
23
24
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_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_response_base.rb', line 38

def state
  @state
end

#street_address ⇒ Object

Returns the value of attribute street_address.



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

def street_address
  @street_address
end

#street_address_line2 ⇒ Object

Returns the value of attribute street_address_line2.



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

def street_address_line2
  @street_address_line2
end

#tax_year ⇒ Object

Returns the value of attribute tax_year.



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

def tax_year
  @tax_year
end

#zip ⇒ Object

Returns the value of attribute zip.



40
41
42
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_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



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
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 285

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 53

def self.attribute_map
  {
    :'issuer_id' => :'issuerId',
    :'issuer_reference_id' => :'issuerReferenceId',
    :'issuer_tin' => :'issuerTin',
    :'tax_year' => :'taxYear',
    :'reference_id' => :'referenceId',
    :'recipient_name' => :'recipientName',
    :'recipient_federal_id' => :'recipientFederalId',
    :'federal_id_type' => :'federalIdType',
    :'recipient_second_name' => :'recipientSecondName',
    :'street_address' => :'streetAddress',
    :'street_address_line2' => :'streetAddressLine2',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'recipient_email' => :'recipientEmail',
    :'account_number' => :'accountNumber',
    :'office_code' => :'officeCode',
    :'recipient_non_us_province' => :'recipientNonUsProvince',
    :'country_code' => :'countryCode'
  }
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 261

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



108
109
110
111
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 83

def self.openapi_types
  {
    :'issuer_id' => :'String',
    :'issuer_reference_id' => :'String',
    :'issuer_tin' => :'String',
    :'tax_year' => :'Integer',
    :'reference_id' => :'String',
    :'recipient_name' => :'String',
    :'recipient_federal_id' => :'String',
    :'federal_id_type' => :'Integer',
    :'recipient_second_name' => :'String',
    :'street_address' => :'String',
    :'street_address_line2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'recipient_email' => :'String',
    :'account_number' => :'String',
    :'office_code' => :'String',
    :'recipient_non_us_province' => :'String',
    :'country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      issuer_id == o.issuer_id &&
      issuer_reference_id == o.issuer_reference_id &&
      issuer_tin == o.issuer_tin &&
      tax_year == o.tax_year &&
      reference_id == o.reference_id &&
      recipient_name == o.recipient_name &&
      recipient_federal_id == o.recipient_federal_id &&
      federal_id_type == o.federal_id_type &&
      recipient_second_name == o.recipient_second_name &&
      street_address == o.street_address &&
      street_address_line2 == o.street_address_line2 &&
      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
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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 356

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


248
249
250
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 254

def hash
  [issuer_id, issuer_reference_id, issuer_tin, tax_year, reference_id, recipient_name, recipient_federal_id, federal_id_type, recipient_second_name, street_address, street_address_line2, city, state, zip, recipient_email, , office_code, recipient_non_us_province, country_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



207
208
209
210
211
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 207

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



332
333
334
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 338

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



326
327
328
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 326

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



215
216
217
218
 
# File 'lib/avalara_sdk/models/A1099/V2/form_response_base.rb', line 215

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