Class: Merge::Crm::Contact

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

Overview

# The Contact Object

### Description
The `Contact` object is used to represent an existing point of contact at a
company in a CRM system.
### Usage Example
TODO

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, first_name: OMIT, last_name: OMIT, account: OMIT, owner: OMIT, addresses: OMIT, email_addresses: OMIT, phone_numbers: OMIT, last_activity_at: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::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.

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

    The contact’s first name.

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

    The contact’s last name.

  • account (Merge::Crm::ContactAccount) (defaults to: OMIT) —

    The contact’s account.

  • owner (Merge::Crm::ContactOwner) (defaults to: OMIT) —

    The contact’s owner.

  • addresses (Array<Merge::Crm::Address>) (defaults to: OMIT)
  • email_addresses (Array<Merge::Crm::EmailAddress>) (defaults to: OMIT)
  • phone_numbers (Array<Merge::Crm::PhoneNumber>) (defaults to: OMIT)
  • last_activity_at (DateTime) (defaults to: OMIT) —

    When the contact’s last activity occurred.

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

    When the third party’s contact was created.

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

    Additional properties unmapped to the current class definition



84
85
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/merge_ruby_client/crm/types/contact.rb', line 84

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, first_name: OMIT, last_name: OMIT,
               account: OMIT, owner: OMIT, addresses: OMIT, email_addresses: OMIT, phone_numbers: OMIT, last_activity_at: OMIT, remote_created_at: 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
  @first_name = first_name if first_name != OMIT
  @last_name = last_name if last_name != OMIT
  @account =  if  != OMIT
  @owner = owner if owner != OMIT
  @addresses = addresses if addresses != OMIT
  @email_addresses = email_addresses if email_addresses != OMIT
  @phone_numbers = phone_numbers if phone_numbers != OMIT
  @last_activity_at = last_activity_at if last_activity_at != OMIT
  @remote_created_at = remote_created_at if remote_created_at != 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,
    "first_name": first_name,
    "last_name": last_name,
    "account": ,
    "owner": owner,
    "addresses": addresses,
    "email_addresses": email_addresses,
    "phone_numbers": phone_numbers,
    "last_activity_at": last_activity_at,
    "remote_created_at": remote_created_at,
    "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

#account ⇒ Merge::Crm::ContactAccount (readonly)

Returns The contact’s account.

Returns:



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

def 
  @account
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



58
59
60
 
# File 'lib/merge_ruby_client/crm/types/contact.rb', line 58

def additional_properties
  @additional_properties
end

#addresses ⇒ Array<Merge::Crm::Address> (readonly)

Returns:



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

def addresses
  @addresses
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.



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

def created_at
  @created_at
end

#email_addresses ⇒ Array<Merge::Crm::EmailAddress> (readonly)

Returns:



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

def email_addresses
  @email_addresses
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#first_name ⇒ String (readonly)

Returns The contact’s first name.

Returns:

  • (String) —

    The contact’s first name.



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

def first_name
  @first_name
end

#id ⇒ String (readonly)

Returns:

  • (String) 


24
25
26
 
# File 'lib/merge_ruby_client/crm/types/contact.rb', line 24

def id
  @id
end

#last_activity_at ⇒ DateTime (readonly)

Returns When the contact’s last activity occurred.

Returns:

  • (DateTime) —

    When the contact’s last activity occurred.



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

def last_activity_at
  @last_activity_at
end

#last_name ⇒ String (readonly)

Returns The contact’s last name.

Returns:

  • (String) —

    The contact’s last name.



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

def last_name
  @last_name
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.



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

def modified_at
  @modified_at
end

#owner ⇒ Merge::Crm::ContactOwner (readonly)

Returns The contact’s owner.

Returns:



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

def owner
  @owner
end

#phone_numbers ⇒ Array<Merge::Crm::PhoneNumber> (readonly)

Returns:



44
45
46
 
# File 'lib/merge_ruby_client/crm/types/contact.rb', line 44

def phone_numbers
  @phone_numbers
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s contact was created.

Returns:

  • (DateTime) —

    When the third party’s contact was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



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

def remote_data
  @remote_data
end

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

Returns:



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

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.



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

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of Contact

Parameters:

  • json_object (String)

Returns:



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

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?)
  first_name = parsed_json["first_name"]
  last_name = parsed_json["last_name"]
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Crm::ContactAccount.from_json(json_object: )
  end
  if parsed_json["owner"].nil?
    owner = nil
  else
    owner = parsed_json["owner"].to_json
    owner = Merge::Crm::ContactOwner.from_json(json_object: owner)
  end
  addresses = parsed_json["addresses"]&.map do |item|
    item = item.to_json
    Merge::Crm::Address.from_json(json_object: item)
  end
  email_addresses = parsed_json["email_addresses"]&.map do |item|
    item = item.to_json
    Merge::Crm::EmailAddress.from_json(json_object: item)
  end
  phone_numbers = parsed_json["phone_numbers"]&.map do |item|
    item = item.to_json
    Merge::Crm::PhoneNumber.from_json(json_object: item)
  end
  last_activity_at = (DateTime.parse(parsed_json["last_activity_at"]) unless parsed_json["last_activity_at"].nil?)
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      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::Crm::RemoteData.from_json(json_object: item)
  end
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Crm::RemoteField.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    first_name: first_name,
    last_name: last_name,
    account: ,
    owner: owner,
    addresses: addresses,
    email_addresses: email_addresses,
    phone_numbers: phone_numbers,
    last_activity_at: last_activity_at,
    remote_created_at: remote_created_at,
    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) 


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/merge_ruby_client/crm/types/contact.rb', line 213

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.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
  obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
  obj..nil? || Merge::Crm::ContactAccount.validate_raw(obj: obj.)
  obj.owner.nil? || Merge::Crm::ContactOwner.validate_raw(obj: obj.owner)
  obj.addresses&.is_a?(Array) != false || raise("Passed value for field obj.addresses is not the expected type, validation failed.")
  obj.email_addresses&.is_a?(Array) != false || raise("Passed value for field obj.email_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.last_activity_at&.is_a?(DateTime) != false || raise("Passed value for field obj.last_activity_at is not the expected type, validation failed.")
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at 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) 


203
204
205
 
# File 'lib/merge_ruby_client/crm/types/contact.rb', line 203

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