Class: MergeAccountingClient::Contact

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/contact.rb

Overview

# The Contact Object ### Description The ‘Contact` object refers to either a supplier or a customer. ### Usage Example Fetch from the `LIST Contacts` endpoint and view a company’s contacts.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Contact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



133
134
135
136
137
138
139
140
141
142
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
 
# File 'lib/merge_accounting_client/models/contact.rb', line 133

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'addresses')
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end

  if attributes.key?(:'phone_numbers')
    if (value = attributes[:'phone_numbers']).is_a?(Array)
      self.phone_numbers = value
    end
  end

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

  if attributes.key?(:'field_mappings')
    if (value = attributes[:'field_mappings']).is_a?(Hash)
      self.field_mappings = value
    end
  end

  if attributes.key?(:'remote_data')
    if (value = attributes[:'remote_data']).is_a?(Array)
      self.remote_data = value
    end
  end
end

Instance Attribute Details

#addresses ⇒ Object

‘Address` object IDs for the given `Contacts` object.



52
53
54
 
# File 'lib/merge_accounting_client/models/contact.rb', line 52

def addresses
  @addresses
end

#company ⇒ Object

The company the contact belongs to.



49
50
51
 
# File 'lib/merge_accounting_client/models/contact.rb', line 49

def company
  @company
end

#currency ⇒ Object

The currency the contact’s transactions are in.



43
44
45
 
# File 'lib/merge_accounting_client/models/contact.rb', line 43

def currency
  @currency
end

#email_address ⇒ Object

The contact’s email address.



34
35
36
 
# File 'lib/merge_accounting_client/models/contact.rb', line 34

def email_address
  @email_address
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



60
61
62
 
# File 'lib/merge_accounting_client/models/contact.rb', line 60

def field_mappings
  @field_mappings
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_accounting_client/models/contact.rb', line 19

def id
  @id
end

#is_customer ⇒ Object

Whether the contact is a customer.



31
32
33
 
# File 'lib/merge_accounting_client/models/contact.rb', line 31

def is_customer
  @is_customer
end

#is_supplier ⇒ Object

Whether the contact is a supplier.



28
29
30
 
# File 'lib/merge_accounting_client/models/contact.rb', line 28

def is_supplier
  @is_supplier
end

#name ⇒ Object

The contact’s name.



25
26
27
 
# File 'lib/merge_accounting_client/models/contact.rb', line 25

def name
  @name
end

#phone_numbers ⇒ Object

‘AccountingPhoneNumber` object for the given `Contacts` object.



55
56
57
 
# File 'lib/merge_accounting_client/models/contact.rb', line 55

def phone_numbers
  @phone_numbers
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



62
63
64
 
# File 'lib/merge_accounting_client/models/contact.rb', line 62

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_accounting_client/models/contact.rb', line 22

def remote_id
  @remote_id
end

#remote_updated_at ⇒ Object

When the third party’s contact was updated.



46
47
48
 
# File 'lib/merge_accounting_client/models/contact.rb', line 46

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Object

Indicates whether or not this object has been deleted by third party webhooks.



58
59
60
 
# File 'lib/merge_accounting_client/models/contact.rb', line 58

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ Object

The contact’s status * ‘ACTIVE` - ACTIVE * `ARCHIVED` - ARCHIVED



40
41
42
 
# File 'lib/merge_accounting_client/models/contact.rb', line 40

def status
  @status
end

#tax_number ⇒ Object

The contact’s tax number.



37
38
39
 
# File 'lib/merge_accounting_client/models/contact.rb', line 37

def tax_number
  @tax_number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/merge_accounting_client/models/contact.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/merge_accounting_client/models/contact.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'name' => :'name',
    :'is_supplier' => :'is_supplier',
    :'is_customer' => :'is_customer',
    :'email_address' => :'email_address',
    :'tax_number' => :'tax_number',
    :'status' => :'status',
    :'currency' => :'currency',
    :'remote_updated_at' => :'remote_updated_at',
    :'company' => :'company',
    :'addresses' => :'addresses',
    :'phone_numbers' => :'phone_numbers',
    :'remote_was_deleted' => :'remote_was_deleted',
    :'field_mappings' => :'field_mappings',
    :'remote_data' => :'remote_data'
  }
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



270
271
272
 
# File 'lib/merge_accounting_client/models/contact.rb', line 270

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/merge_accounting_client/models/contact.rb', line 114

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'name',
    :'is_supplier',
    :'is_customer',
    :'email_address',
    :'tax_number',
    :'status',
    :'currency',
    :'remote_updated_at',
    :'company',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/merge_accounting_client/models/contact.rb', line 92

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'name' => :'String',
    :'is_supplier' => :'Boolean',
    :'is_customer' => :'Boolean',
    :'email_address' => :'String',
    :'tax_number' => :'String',
    :'status' => :'Status7d1Enum',
    :'currency' => :'String',
    :'remote_updated_at' => :'Time',
    :'company' => :'String',
    :'addresses' => :'Array<String>',
    :'phone_numbers' => :'Array<AccountingPhoneNumber>',
    :'remote_was_deleted' => :'Boolean',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      name == o.name &&
      is_supplier == o.is_supplier &&
      is_customer == o.is_customer &&
      email_address == o.email_address &&
      tax_number == o.tax_number &&
      status == o.status &&
      currency == o.currency &&
      remote_updated_at == o.remote_updated_at &&
      company == o.company &&
      addresses == o.addresses &&
      phone_numbers == o.phone_numbers &&
      remote_was_deleted == o.remote_was_deleted &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
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



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
333
334
335
336
337
 
# File 'lib/merge_accounting_client/models/contact.rb', line 300

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeAccountingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/merge_accounting_client/models/contact.rb', line 371

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/merge_accounting_client/models/contact.rb', line 277

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/merge_accounting_client/models/contact.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/merge_accounting_client/models/contact.rb', line 263

def hash
  [id, remote_id, name, is_supplier, is_customer, email_address, tax_number, status, currency, remote_updated_at, company, addresses, phone_numbers, remote_was_deleted, field_mappings, remote_data].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



221
222
223
224
 
# File 'lib/merge_accounting_client/models/contact.rb', line 221

def list_invalid_properties
  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



347
348
349
 
# File 'lib/merge_accounting_client/models/contact.rb', line 347

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/merge_accounting_client/models/contact.rb', line 353

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



341
342
343
 
# File 'lib/merge_accounting_client/models/contact.rb', line 341

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



228
229
230
 
# File 'lib/merge_accounting_client/models/contact.rb', line 228

def valid?
  true
end