Class: AvalaraSdk::A1099::V2::W4FormMinimalRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ W4FormMinimalRequest

Initializes the object



105
106
107
108
109
110
111
112
113
114
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
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 105

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

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

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

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

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

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

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

Instance Attribute Details

#company_id ⇒ Object

The ID of the associated company.



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

def company_id
  @company_id
end

#email ⇒ Object

The email address of the individual associated with the form.



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

def email
  @email
end

#employee_first_name ⇒ Object

The first name of the employee.



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

def employee_first_name
  @employee_first_name
end

#employee_last_name ⇒ Object

The last name of the employee.



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

def employee_last_name
  @employee_last_name
end

#office_code ⇒ Object

The office code associated with the form.



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

def office_code
  @office_code
end

#reference_id ⇒ Object

A reference identifier for the form.



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

def reference_id
  @reference_id
end

#type ⇒ Object

The form type (always "w4" for this model).



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

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



331
332
333
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
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 331

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



71
72
73
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 58

def self.attribute_map
  {
    :'type' => :'type',
    :'email' => :'email',
    :'employee_first_name' => :'employeeFirstName',
    :'employee_last_name' => :'employeeLastName',
    :'office_code' => :'officeCode',
    :'company_id' => :'companyId',
    :'reference_id' => :'referenceId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 307

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)



97
98
99
100
101
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 97

def self.openapi_all_of
  [
  :'W9FormBaseMinimalRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
94
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 89

def self.openapi_nullable
  Set.new([
    :'office_code',
    :'reference_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 76

def self.openapi_types
  {
    :'type' => :'String',
    :'email' => :'String',
    :'employee_first_name' => :'String',
    :'employee_last_name' => :'String',
    :'office_code' => :'String',
    :'company_id' => :'String',
    :'reference_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 280

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      email == o.email &&
      employee_first_name == o.employee_first_name &&
      employee_last_name == o.employee_last_name &&
      office_code == o.office_code &&
      company_id == o.company_id &&
      reference_id == o.reference_id
end

#_to_hash(value) ⇒ Hash

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 402

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



300
301
302
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 300

def hash
  [type, email, employee_first_name, employee_last_name, office_code, company_id, reference_id].hash
end

#list_invalid_properties ⇒ Object

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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @email.to_s.length < 1
    invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
  end

  if @employee_first_name.nil?
    invalid_properties.push('invalid value for "employee_first_name", employee_first_name cannot be nil.')
  end

  if @employee_first_name.to_s.length < 1
    invalid_properties.push('invalid value for "employee_first_name", the character length must be great than or equal to 1.')
  end

  if @employee_last_name.nil?
    invalid_properties.push('invalid value for "employee_last_name", employee_last_name cannot be nil.')
  end

  if @employee_last_name.to_s.length < 1
    invalid_properties.push('invalid value for "employee_last_name", the character length must be great than or equal to 1.')
  end

  if @company_id.nil?
    invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
  end

  if @company_id.to_s.length < 1
    invalid_properties.push('invalid value for "company_id", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



378
379
380
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 378

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 384

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



372
373
374
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 372

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb', line 197

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["W4", "W8Ben", "W8BenE", "W8Imy", "W9"])
  return false unless type_validator.valid?(@type)
  return false if @email.nil?
  return false if @email.to_s.length < 1
  return false if @employee_first_name.nil?
  return false if @employee_first_name.to_s.length < 1
  return false if @employee_last_name.nil?
  return false if @employee_last_name.to_s.length < 1
  return false if @company_id.nil?
  return false if @company_id.to_s.length < 1
  true
end