Class: AvalaraSdk::A1099::V2::JobResponse

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

Overview

Response model for job operations

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
254
255
256
257
258
259
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 165

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

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

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

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

  if attributes.key?(:'processed_forms')
    if (value = attributes[:'processed_forms']).is_a?(Array)
      self.processed_forms = value
    end
  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. Value can be 0 or another value based on what the job has available



55
56
57
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 55

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. Value can be 0 or another value based on what the job has available



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

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. Value can be 0 or another value based on what the job has available



61
62
63
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 61

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.



64
65
66
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 64

def dry_run
  @dry_run
end

#error_message ⇒ Object

Error message if the job failed, null otherwise



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

def error_message
  @error_message
end

#id ⇒ Object

Unique identifier for the job



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

def id
  @id
end

#link ⇒ Object

Link to access the job details



70
71
72
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 70

def link
  @link
end

#not_found ⇒ Object

Number of forms skipped because no matching form or issuer could be found. Value can be 0 or another value based on what the job has available



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

def not_found
  @not_found
end

#processed_forms ⇒ Object

List of processed forms returned when bulk-upsert processes ≤1000 records. Same format as GET /1099/forms response. Only available in bulk-upsert endpoint responses.



73
74
75
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 73

def processed_forms
  @processed_forms
end

#skipped_duplicate ⇒ Object

Number of forms skipped because they would have updated a record already updated once in the request. Value can be 0 or another value based on what the job has available



43
44
45
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 43

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. Value can be 0 or another value based on what the job has available



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

def skipped_invalid
  @skipped_invalid
end

#skipped_multiple_matches ⇒ Object

Number of forms skipped because they matched multiple forms. Value can be 0 or another value based on what the job has available



49
50
51
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 49

def skipped_multiple_matches
  @skipped_multiple_matches
end

#status ⇒ Object

Current status of the job (e.g., Success, Failed, InProgress)



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

def status
  @status
end

#total_processed ⇒ Object

Total number of forms processed. Value can be 0 or another value based on what the job has available



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

def total_processed
  @total_processed
end

#total_rows ⇒ Object

Total number of forms in the request. Value can be 0 or another value based on what the job has available



31
32
33
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 31

def total_rows
  @total_rows
end

#type ⇒ Object

Job type identifier. Will always be "update_job" for bulk upsert operations



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

def type
  @type
end

#updated_invalid ⇒ Object

Number of forms updated but invalid for e-filing. Value can be 0 or another value based on what the job has available



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

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. Value can be 0 or another value based on what the job has available



37
38
39
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 37

def updated_no_email
  @updated_no_email
end

#updated_valid ⇒ Object

Number of forms updated and valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available



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

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.



67
68
69
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 67

def upsert
  @upsert
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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 360

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



124
125
126
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 124

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'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',
    :'dry_run' => :'dryRun',
    :'upsert' => :'upsert',
    :'link' => :'link',
    :'processed_forms' => :'processedForms'
  }
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 336

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



155
156
157
158
159
160
161
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 155

def self.openapi_nullable
  Set.new([
    :'error_message',
    :'link',
    :'processed_forms'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 129

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'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',
    :'dry_run' => :'Boolean',
    :'upsert' => :'Boolean',
    :'link' => :'String',
    :'processed_forms' => :'Array<Get1099Form200Response>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      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 &&
      dry_run == o.dry_run &&
      upsert == o.upsert &&
      link == o.link &&
      processed_forms == o.processed_forms
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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 431

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


323
324
325
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 329

def hash
  [id, type, 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, dry_run, upsert, link, processed_forms].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



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

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



407
408
409
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 413

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



401
402
403
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 401

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



271
272
273
274
275
276
 
# File 'lib/avalara_sdk/models/A1099/V2/job_response.rb', line 271

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["InProgress", "Success", "Failed"])
  return false unless status_validator.valid?(@status)
  true
end