Class: AvalaraSdk::A1099::V2::JobResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobResult

Initializes the object



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
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_invalid ⇒ Object

Number of new forms created because no matching form could be found (and ‘upsert` was true) - with errors



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

def created_invalid
  @created_invalid
end

#created_no_email ⇒ Object

Number of new forms created because no matching form could be found (and ‘upsert` was true) - valid for e-filing but missing email or email is undeliverable



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

def created_no_email
  @created_no_email
end

#created_valid ⇒ Object

Number of new forms created because no matching form could be found (and ‘upsert` was true) - valid for e-filing and e-delivery



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

def created_valid
  @created_valid
end

#dry_run ⇒ Object

Dry run. If ‘true`, this job only simulates the changes but doesn’t actually persist them.



19
20
21
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 19

def dry_run
  @dry_run
end

#error_message ⇒ Object

Returns the value of attribute error_message.



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

def error_message
  @error_message
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#not_found ⇒ Object

Number of forms skipped because no matching form or issuer could be found



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

def not_found
  @not_found
end

#skipped_duplicate ⇒ Object

Number of forms skipped because they would have updated a record already updated once in the request



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

def skipped_duplicate
  @skipped_duplicate
end

#skipped_invalid ⇒ Object

Number of forms skipped because they would have made a form invalid and the form is already e-filed or scheduled for e-filing



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

def skipped_invalid
  @skipped_invalid
end

#skipped_multiple_matches ⇒ Object

Number of forms skipped because they matched multiple forms



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

def skipped_multiple_matches
  @skipped_multiple_matches
end

#status ⇒ Object

Status of the job



25
26
27
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 25

def status
  @status
end

#total_processed ⇒ Object

Total number of forms processed



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

def total_processed
  @total_processed
end

#total_rows ⇒ Object

Total number of forms in the request



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

def total_rows
  @total_rows
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_invalid ⇒ Object

Number of forms updated but invalid for e-filing



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

def updated_invalid
  @updated_invalid
end

#updated_no_email ⇒ Object

Number of forms updated and valid for e-filing but missing email or email is undeliverable



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

def updated_no_email
  @updated_no_email
end

#updated_valid ⇒ Object

Number of forms updated and valid for e-filing and e-delivery



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

def updated_valid
  @updated_valid
end

#upsert ⇒ Object

Upsert. If ‘true`, this job will first attempt to update existing records if matches can be found. Matches are done in the following order: * Form ID * Form Reference ID and tax year * Form TIN and tax year



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

def upsert
  @upsert
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
323
324
325
326
327
328
329
330
331
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 294

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'dry_run' => :'dryRun',
    :'upsert' => :'upsert',
    :'status' => :'status',
    :'error_message' => :'errorMessage',
    :'total_processed' => :'totalProcessed',
    :'total_rows' => :'totalRows',
    :'updated_valid' => :'updatedValid',
    :'updated_no_email' => :'updatedNoEmail',
    :'updated_invalid' => :'updatedInvalid',
    :'skipped_duplicate' => :'skippedDuplicate',
    :'skipped_invalid' => :'skippedInvalid',
    :'skipped_multiple_matches' => :'skippedMultipleMatches',
    :'not_found' => :'notFound',
    :'created_invalid' => :'createdInvalid',
    :'created_no_email' => :'createdNoEmail',
    :'created_valid' => :'createdValid'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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/job_result.rb', line 270

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



119
120
121
122
123
124
125
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 119

def self.openapi_nullable
  Set.new([
    :'type',
    :'status',
    :'error_message',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'dry_run' => :'Boolean',
    :'upsert' => :'Boolean',
    :'status' => :'String',
    :'error_message' => :'String',
    :'total_processed' => :'Integer',
    :'total_rows' => :'Integer',
    :'updated_valid' => :'Integer',
    :'updated_no_email' => :'Integer',
    :'updated_invalid' => :'Integer',
    :'skipped_duplicate' => :'Integer',
    :'skipped_invalid' => :'Integer',
    :'skipped_multiple_matches' => :'Integer',
    :'not_found' => :'Integer',
    :'created_invalid' => :'Integer',
    :'created_no_email' => :'Integer',
    :'created_valid' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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/job_result.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      dry_run == o.dry_run &&
      upsert == o.upsert &&
      status == o.status &&
      error_message == o.error_message &&
      total_processed == o.total_processed &&
      total_rows == o.total_rows &&
      updated_valid == o.updated_valid &&
      updated_no_email == o.updated_no_email &&
      updated_invalid == o.updated_invalid &&
      skipped_duplicate == o.skipped_duplicate &&
      skipped_invalid == o.skipped_invalid &&
      skipped_multiple_matches == o.skipped_multiple_matches &&
      not_found == o.not_found &&
      created_invalid == o.created_invalid &&
      created_no_email == o.created_no_email &&
      created_valid == o.created_valid
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 365

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

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



263
264
265
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 263

def hash
  [id, type, dry_run, upsert, status, error_message, total_processed, total_rows, updated_valid, updated_no_email, updated_invalid, skipped_duplicate, skipped_invalid, skipped_multiple_matches, not_found, created_invalid, created_no_email, created_valid].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



217
218
219
220
221
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 217

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)



341
342
343
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 341

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 347

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



335
336
337
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 335

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



225
226
227
228
 
# File 'lib/avalara_sdk/models/A1099/V2/job_result.rb', line 225

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