Class: AvalaraSdk::A1099::V2::W9FormMinimalRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/models/A1099/V2/w9_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 = {}) ⇒ W9FormMinimalRequest

Initializes the object



100
101
102
103
104
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
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 100

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

  if attributes.key?(:'account_number')
    self. = attributes[:'account_number']
  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

#account_number ⇒ Object

The account number associated with the form.



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

def 
  @account_number
end

#company_id ⇒ Object

The ID of the associated company.



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

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/w9_form_minimal_request.rb', line 18

def email
  @email
end

#name ⇒ Object

The name of the individual or entity associated with the form.



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

def name
  @name
end

#reference_id ⇒ Object

A reference identifier for the form.



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

def reference_id
  @reference_id
end

#type ⇒ Object

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



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

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 55

def self.attribute_map
  {
    :'type' => :'type',
    :'email' => :'email',
    :'name' => :'name',
    :'account_number' => :'accountNumber',
    :'company_id' => :'companyId',
    :'reference_id' => :'referenceId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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)



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

def self.openapi_all_of
  [
  :'W9FormBaseMinimalRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
88
89
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 72

def self.openapi_types
  {
    :'type' => :'String',
    :'email' => :'String',
    :'name' => :'String',
    :'account_number' => :'String',
    :'company_id' => :'String',
    :'reference_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      email == o.email &&
      name == o.name &&
       == o. &&
      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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



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

def hash
  [type, email, name, , company_id, reference_id].hash
end

#list_invalid_properties ⇒ Object

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



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

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 @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "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)



342
343
344
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 342

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



336
337
338
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 336

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb', line 178

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 @name.nil?
  return false if @name.to_s.length < 1
  return false if @company_id.nil?
  return false if @company_id.to_s.length < 1
  true
end