Class: AvalaraSdk::A1099::V2::IssuerResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IssuerResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Address.



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

def address
  @address
end

#city ⇒ Object

City.



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

def city
  @city
end

#country_code ⇒ Object

Two-letter IRS country code (e.g., ‘US’, ‘CA’), as defined at www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent’s shipping address.



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

def country_code
  @country_code
end

#created_at ⇒ Object

Date time when the record was created.



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

def created_at
  @created_at
end

#dba_name ⇒ Object

Doing Business As (DBA) name or continuation of a long legal name. Use either this or ‘transferAgentName’.



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

def dba_name
  @dba_name
end

#email ⇒ Object

Contact email address. For recipient inquiries.



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

def email
  @email
end

#foreign_province ⇒ Object

Province or region for non-US/CA addresses.



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

def foreign_province
  @foreign_province
end

#id ⇒ Object

Unique identifier set when the record is created.



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

def id
  @id
end

#last_filing ⇒ Object

Indicates if this is the issuer’s final year filing.



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

def last_filing
  @last_filing
end

#name ⇒ Object

Legal name. Not the DBA name.



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

def name
  @name
end

#reference_id ⇒ Object

Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces.



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

def reference_id
  @reference_id
end

#state ⇒ Object

Two-letter US state or Canadian province code (required for US/CA addresses).



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

def state
  @state
end

#tax_year ⇒ Object

Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4.



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

def tax_year
  @tax_year
end

#telephone ⇒ Object

Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries.



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

def telephone
  @telephone
end

#tin ⇒ Object

Federal Tax Identification Number (TIN).



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

def tin
  @tin
end

#transfer_agent_name ⇒ Object

Name of the transfer agent, if applicable — optional; use either this or ‘dbaName’.



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

def transfer_agent_name
  @transfer_agent_name
end

#updated_at ⇒ Object

Date time when the record was last updated.



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

def updated_at
  @updated_at
end

#zip ⇒ Object

ZIP/postal code.



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

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



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
366
367
368
369
370
371
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 334

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



93
94
95
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'dba_name' => :'dbaName',
    :'tin' => :'tin',
    :'reference_id' => :'referenceId',
    :'telephone' => :'telephone',
    :'tax_year' => :'taxYear',
    :'country_code' => :'countryCode',
    :'email' => :'email',
    :'address' => :'address',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'foreign_province' => :'foreignProvince',
    :'transfer_agent_name' => :'transferAgentName',
    :'last_filing' => :'lastFiling'
  }
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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 310

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)



143
144
145
146
147
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 143

def self.openapi_all_of
  [
  :'IssuerCommand'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 122

def self.openapi_nullable
  Set.new([
    :'name',
    :'dba_name',
    :'tin',
    :'reference_id',
    :'telephone',
    :'tax_year',
    :'country_code',
    :'email',
    :'address',
    :'city',
    :'state',
    :'zip',
    :'foreign_province',
    :'transfer_agent_name',
    :'last_filing'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 98

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'dba_name' => :'String',
    :'tin' => :'String',
    :'reference_id' => :'String',
    :'telephone' => :'String',
    :'tax_year' => :'Integer',
    :'country_code' => :'String',
    :'email' => :'String',
    :'address' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'foreign_province' => :'String',
    :'transfer_agent_name' => :'String',
    :'last_filing' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      dba_name == o.dba_name &&
      tin == o.tin &&
      reference_id == o.reference_id &&
      telephone == o.telephone &&
      tax_year == o.tax_year &&
      country_code == o.country_code &&
      email == o.email &&
      address == o.address &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      foreign_province == o.foreign_province &&
      transfer_agent_name == o.transfer_agent_name &&
      last_filing == o.last_filing
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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 405

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


297
298
299
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 303

def hash
  [id, created_at, updated_at, name, dba_name, tin, reference_id, telephone, tax_year, country_code, email, address, city, state, zip, foreign_province, transfer_agent_name, last_filing].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



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

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



381
382
383
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 381

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 387

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



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

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



265
266
267
268
 
# File 'lib/avalara_sdk/models/A1099/V2/issuer_response.rb', line 265

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