Class: XeroRuby::Accounting::TenNinetyNineContact

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TenNinetyNineContact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#box1Object

Box 1 on 1099 Form



20
21
22
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 20

def box1
  @box1
end

#box10Object

Box 10 on 1099 Form



47
48
49
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 47

def box10
  @box10
end

#box11Object

Box 11 on 1099 Form



50
51
52
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 50

def box11
  @box11
end

#box13Object

Box 13 on 1099 Form



53
54
55
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 53

def box13
  @box13
end

#box14Object

Box 14 on 1099 Form



56
57
58
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 56

def box14
  @box14
end

#box2Object

Box 2 on 1099 Form



23
24
25
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 23

def box2
  @box2
end

#box3Object

Box 3 on 1099 Form



26
27
28
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 26

def box3
  @box3
end

#box4Object

Box 4 on 1099 Form



29
30
31
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 29

def box4
  @box4
end

#box5Object

Box 5 on 1099 Form



32
33
34
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 32

def box5
  @box5
end

#box6Object

Box 6 on 1099 Form



35
36
37
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 35

def box6
  @box6
end

#box7Object

Box 7 on 1099 Form



38
39
40
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 38

def box7
  @box7
end

#box8Object

Box 8 on 1099 Form



41
42
43
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 41

def box8
  @box8
end

#box9Object

Box 9 on 1099 Form



44
45
46
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 44

def box9
  @box9
end

#cityObject

Contact city on 1099 Form



65
66
67
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 65

def city
  @city
end

#contact_idObject

Contact contact id



83
84
85
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 83

def contact_id
  @contact_id
end

#emailObject

Contact email on 1099 Form



74
75
76
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 74

def email
  @email
end

#federal_tax_id_typeObject

Contact Fed Tax ID type



62
63
64
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 62

def federal_tax_id_type
  @federal_tax_id_type
end

#nameObject

Contact name on 1099 Form



59
60
61
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 59

def name
  @name
end

#stateObject

Contact State on 1099 Form



71
72
73
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 71

def state
  @state
end

#street_addressObject

Contact address on 1099 Form



77
78
79
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 77

def street_address
  @street_address
end

#tax_idObject

Contact tax id on 1099 Form



80
81
82
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 80

def tax_id
  @tax_id
end

#zipObject

Contact zip on 1099 Form



68
69
70
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 68

def zip
  @zip
end

Class Method Details

.attribute_mapObject

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 86

def self.attribute_map
  {
    :'box1' => :'Box1',
    :'box2' => :'Box2',
    :'box3' => :'Box3',
    :'box4' => :'Box4',
    :'box5' => :'Box5',
    :'box6' => :'Box6',
    :'box7' => :'Box7',
    :'box8' => :'Box8',
    :'box9' => :'Box9',
    :'box10' => :'Box10',
    :'box11' => :'Box11',
    :'box13' => :'Box13',
    :'box14' => :'Box14',
    :'name' => :'Name',
    :'federal_tax_id_type' => :'FederalTaxIDType',
    :'city' => :'City',
    :'zip' => :'Zip',
    :'state' => :'State',
    :'email' => :'Email',
    :'street_address' => :'StreetAddress',
    :'tax_id' => :'TaxID',
    :'contact_id' => :'ContactId'
  }
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



302
303
304
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 302

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 114

def self.openapi_types
  {
    :'box1' => :'BigDecimal',
    :'box2' => :'BigDecimal',
    :'box3' => :'BigDecimal',
    :'box4' => :'BigDecimal',
    :'box5' => :'BigDecimal',
    :'box6' => :'BigDecimal',
    :'box7' => :'BigDecimal',
    :'box8' => :'BigDecimal',
    :'box9' => :'BigDecimal',
    :'box10' => :'BigDecimal',
    :'box11' => :'BigDecimal',
    :'box13' => :'BigDecimal',
    :'box14' => :'BigDecimal',
    :'name' => :'String',
    :'federal_tax_id_type' => :'String',
    :'city' => :'String',
    :'zip' => :'String',
    :'state' => :'String',
    :'email' => :'String',
    :'street_address' => :'String',
    :'tax_id' => :'String',
    :'contact_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      box1 == o.box1 &&
      box2 == o.box2 &&
      box3 == o.box3 &&
      box4 == o.box4 &&
      box5 == o.box5 &&
      box6 == o.box6 &&
      box7 == o.box7 &&
      box8 == o.box8 &&
      box9 == o.box9 &&
      box10 == o.box10 &&
      box11 == o.box11 &&
      box13 == o.box13 &&
      box14 == o.box14 &&
      name == o.name &&
      federal_tax_id_type == o.federal_tax_id_type &&
      city == o.city &&
      zip == o.zip &&
      state == o.state &&
      email == o.email &&
      street_address == o.street_address &&
      tax_id == o.tax_id &&
      contact_id == o.contact_id
end

#_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



330
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
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 330

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
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



403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 403

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

#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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 309

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 289

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



295
296
297
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 295

def hash
  [box1, box2, box3, box4, box5, box6, box7, box8, box9, box10, box11, box13, box14, name, federal_tax_id_type, city, zip, state, email, street_address, tax_id, contact_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



247
248
249
250
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 247

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object



417
418
419
420
421
422
423
424
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 417

def parse_date(datestring)
  if datestring.include?('Date')
    seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
    Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case



395
396
397
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 395

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



377
378
379
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 377

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



383
384
385
386
387
388
389
390
391
392
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 383

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



371
372
373
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 371

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



254
255
256
# File 'lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb', line 254

def valid?
  true
end