Class: Merge::Accounting::Contact

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/types/contact.rb

Overview

# The Contact Object

### Description
A `Contact` is an individual or business entity to which products and services
are sold to or purchased from. The `Contact` model contains both Customers, in
which products and services are sold to, and Vendors (or Suppliers), in which
products and services are purchased from.
* A `Contact` is a Vendor/Supplier if the `is_supplier` property is true.
* A `Contact` is a customer if the `is_customer` property is true.
### Usage Example
Fetch from the `LIST Contacts` endpoint and view a company's contacts.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, is_supplier: OMIT, is_customer: OMIT, email_address: OMIT, tax_number: OMIT, status: OMIT, currency: OMIT, remote_updated_at: OMIT, company: OMIT, addresses: OMIT, phone_numbers: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Contact

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • name (String) (defaults to: OMIT) —

    The contact’s name.

  • is_supplier (Boolean) (defaults to: OMIT) —

    Whether the contact is a supplier.

  • is_customer (Boolean) (defaults to: OMIT) —

    Whether the contact is a customer.

  • email_address (String) (defaults to: OMIT) —

    The contact’s email address.

  • tax_number (String) (defaults to: OMIT) —

    The contact’s tax number.

  • status (Merge::Accounting::Status7D1Enum) (defaults to: OMIT) —

    The contact’s status

    • ‘ACTIVE` - ACTIVE

    • ‘ARCHIVED` - ARCHIVED

  • currency (String) (defaults to: OMIT) —

    The currency the contact’s transactions are in.

  • remote_updated_at (DateTime) (defaults to: OMIT) —

    When the third party’s contact was updated.

  • company (String) (defaults to: OMIT) —

    The company the contact belongs to.

  • addresses (Array<Merge::Accounting::ContactAddressesItem>) (defaults to: OMIT) —

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

  • phone_numbers (Array<Merge::Accounting::AccountingPhoneNumber>) (defaults to: OMIT) —

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

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Accounting::RemoteData>) (defaults to: OMIT)
  • remote_fields (Array<Merge::Accounting::RemoteField>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 102

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, is_supplier: OMIT,
               is_customer: OMIT, email_address: OMIT, tax_number: OMIT, status: OMIT, currency: OMIT, remote_updated_at: OMIT, company: OMIT, addresses: OMIT, phone_numbers: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @name = name if name != OMIT
  @is_supplier = is_supplier if is_supplier != OMIT
  @is_customer = is_customer if is_customer != OMIT
  @email_address = email_address if email_address != OMIT
  @tax_number = tax_number if tax_number != OMIT
  @status = status if status != OMIT
  @currency = currency if currency != OMIT
  @remote_updated_at = remote_updated_at if remote_updated_at != OMIT
  @company = company if company != OMIT
  @addresses = addresses if addresses != OMIT
  @phone_numbers = phone_numbers if phone_numbers != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "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,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



69
70
71
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 69

def additional_properties
  @additional_properties
end

#addresses ⇒ Array<Merge::Accounting::ContactAddressesItem> (readonly)

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

Returns:



54
55
56
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 54

def addresses
  @addresses
end

#company ⇒ String (readonly)

Returns The company the contact belongs to.

Returns:

  • (String) —

    The company the contact belongs to.



52
53
54
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 52

def company
  @company
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



30
31
32
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 30

def created_at
  @created_at
end

#currency ⇒ String (readonly)

Returns The currency the contact’s transactions are in.

Returns:

  • (String) —

    The currency the contact’s transactions are in.



48
49
50
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 48

def currency
  @currency
end

#email_address ⇒ String (readonly)

Returns The contact’s email address.

Returns:

  • (String) —

    The contact’s email address.



40
41
42
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 40

def email_address
  @email_address
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


63
64
65
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 63

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


26
27
28
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 26

def id
  @id
end

#is_customer ⇒ Boolean (readonly)

Returns Whether the contact is a customer.

Returns:

  • (Boolean) —

    Whether the contact is a customer.



38
39
40
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 38

def is_customer
  @is_customer
end

#is_supplier ⇒ Boolean (readonly)

Returns Whether the contact is a supplier.

Returns:

  • (Boolean) —

    Whether the contact is a supplier.



36
37
38
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 36

def is_supplier
  @is_supplier
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



32
33
34
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 32

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The contact’s name.

Returns:

  • (String) —

    The contact’s name.



34
35
36
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 34

def name
  @name
end

#phone_numbers ⇒ Array<Merge::Accounting::AccountingPhoneNumber> (readonly)

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

Returns:



56
57
58
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 56

def phone_numbers
  @phone_numbers
end

#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)

Returns:



65
66
67
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 65

def remote_data
  @remote_data
end

#remote_fields ⇒ Array<Merge::Accounting::RemoteField> (readonly)

Returns:



67
68
69
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 67

def remote_fields
  @remote_fields
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



28
29
30
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 28

def remote_id
  @remote_id
end

#remote_updated_at ⇒ DateTime (readonly)

Returns When the third party’s contact was updated.

Returns:

  • (DateTime) —

    When the third party’s contact was updated.



50
51
52
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 50

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



61
62
63
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 61

def remote_was_deleted
  @remote_was_deleted
end

#status ⇒ Merge::Accounting::Status7D1Enum (readonly)

Returns The contact’s status

  • ‘ACTIVE` - ACTIVE

  • ‘ARCHIVED` - ARCHIVED.

Returns:



46
47
48
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 46

def status
  @status
end

#tax_number ⇒ String (readonly)

Returns The contact’s tax number.

Returns:

  • (String) —

    The contact’s tax number.



42
43
44
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 42

def tax_number
  @tax_number
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Accounting::Contact

Deserialize a JSON object to an instance of Contact

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 153

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  name = parsed_json["name"]
  is_supplier = parsed_json["is_supplier"]
  is_customer = parsed_json["is_customer"]
  email_address = parsed_json["email_address"]
  tax_number = parsed_json["tax_number"]
  status = parsed_json["status"]
  currency = parsed_json["currency"]
  remote_updated_at = unless parsed_json["remote_updated_at"].nil?
                        DateTime.parse(parsed_json["remote_updated_at"])
                      end
  company = parsed_json["company"]
  addresses = parsed_json["addresses"]&.map do |item|
    item = item.to_json
    Merge::Accounting::ContactAddressesItem.from_json(json_object: item)
  end
  phone_numbers = parsed_json["phone_numbers"]&.map do |item|
    item = item.to_json
    Merge::Accounting::AccountingPhoneNumber.from_json(json_object: item)
  end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteData.from_json(json_object: item)
  end
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Accounting::RemoteField.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    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,
    remote_fields: remote_fields,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 226

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.is_supplier&.is_a?(Boolean) != false || raise("Passed value for field obj.is_supplier is not the expected type, validation failed.")
  obj.is_customer&.is_a?(Boolean) != false || raise("Passed value for field obj.is_customer is not the expected type, validation failed.")
  obj.email_address&.is_a?(String) != false || raise("Passed value for field obj.email_address is not the expected type, validation failed.")
  obj.tax_number&.is_a?(String) != false || raise("Passed value for field obj.tax_number is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Accounting::Status7D1Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.currency&.is_a?(String) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.")
  obj.remote_updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_updated_at is not the expected type, validation failed.")
  obj.company&.is_a?(String) != false || raise("Passed value for field obj.company is not the expected type, validation failed.")
  obj.addresses&.is_a?(Array) != false || raise("Passed value for field obj.addresses is not the expected type, validation failed.")
  obj.phone_numbers&.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
  obj.remote_fields&.is_a?(Array) != false || raise("Passed value for field obj.remote_fields is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Contact to a JSON object

Returns:

  • (String) 


216
217
218
 
# File 'lib/merge_ruby_client/accounting/types/contact.rb', line 216

def to_json(*_args)
  @_field_set&.to_json
end