Class: AvalaraSdk::A1099::V2::FormRequestModel

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormRequestModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
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
143
144
145
146
147
148
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 92

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#company_email ⇒ Object

Contact email of your company, set in the W-9 UI



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

def company_email
  @company_email
end

#company_id ⇒ Object

Track1099’s ID of your company, found in the W-9 UI



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

def company_id
  @company_id
end

#company_name ⇒ Object

Name of your company, set in the W-9 UI



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

def company_name
  @company_name
end

#expires_at ⇒ Object

Timestamp when this FormRequest will expire, ttl (or 3600) seconds from creation



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

def expires_at
  @expires_at
end

#form_type ⇒ Object

"W9" is currently the only supported value



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

def form_type
  @form_type
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#reference_id ⇒ Object

Your internal identifier for the vendor from whom you are requesting a form



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

def reference_id
  @reference_id
end

#signed_at ⇒ Object

The timestamp this vendor (identified by your ReferenceId) last signed a complete W-9, null if you did not include a ReferenceId or the vendor has not yet signed a W-9 in Track1099



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

def signed_at
  @signed_at
end

#signed_pdf ⇒ Object

URL of PDF representation of just-signed form, otherwise null. Integrations may use this value to offer a "download for your records" function after a vendor completes and signs a form. Link expires at the same time as this FormRequest. Treat the format of this URL as opaque and expect it to change in the future.



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

def signed_pdf
  @signed_pdf
end

#tin_match_status ⇒ Object

Result of IRS TIN match query for name and TIN in the last signed form, null if signed_at is null



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

def tin_match_status
  @tin_match_status
end

#type ⇒ Object

Returns the value of attribute type.



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

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 258

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'form_type' => :'formType',
    :'company_id' => :'companyId',
    :'company_name' => :'companyName',
    :'company_email' => :'companyEmail',
    :'reference_id' => :'referenceId',
    :'signed_at' => :'signedAt',
    :'tin_match_status' => :'tinMatchStatus',
    :'expires_at' => :'expiresAt',
    :'signed_pdf' => :'signedPdf'
  }
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 234

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



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 68

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'form_type' => :'String',
    :'company_id' => :'Integer',
    :'company_name' => :'String',
    :'company_email' => :'String',
    :'reference_id' => :'String',
    :'signed_at' => :'Time',
    :'tin_match_status' => :'String',
    :'expires_at' => :'Time',
    :'signed_pdf' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      form_type == o.form_type &&
      company_id == o.company_id &&
      company_name == o.company_name &&
      company_email == o.company_email &&
      reference_id == o.reference_id &&
      signed_at == o.signed_at &&
      tin_match_status == o.tin_match_status &&
      expires_at == o.expires_at &&
      signed_pdf == o.signed_pdf
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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 329

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


221
222
223
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 227

def hash
  [id, type, form_type, company_id, company_name, company_email, reference_id, signed_at, tin_match_status, expires_at, signed_pdf].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



152
153
154
155
156
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 152

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



305
306
307
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 311

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



299
300
301
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 299

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



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/avalara_sdk/models/A1099/V2/form_request_model.rb', line 160

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["FormRequest"])
  return false unless type_validator.valid?(@type)
  form_type_validator = EnumAttributeValidator.new('String', ["W9"])
  return false unless form_type_validator.valid?(@form_type)
  tin_match_status_validator = EnumAttributeValidator.new('String', ["None", "Matched"])
  return false unless tin_match_status_validator.valid?(@tin_match_status)
  true
end