Class: Merge::Crm::PatchedContactRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/types/patched_contact_request.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(first_name: OMIT, last_name: OMIT, account: OMIT, owner: OMIT, addresses: OMIT, email_addresses: OMIT, phone_numbers: OMIT, last_activity_at: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil) ⇒ Merge::Crm::PatchedContactRequest

Parameters:

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

    The contact’s first name.

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

    The contact’s last name.

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

    The contact’s account.

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

    The contact’s owner.

  • addresses (Array<Merge::Crm::AddressRequest>) (defaults to: OMIT)
  • email_addresses (Array<Merge::Crm::EmailAddressRequest>) (defaults to: OMIT)
  • phone_numbers (Array<Merge::Crm::PhoneNumberRequest>) (defaults to: OMIT)
  • last_activity_at (DateTime) (defaults to: OMIT) —

    When the contact’s last activity occurred.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • remote_fields (Array<Merge::Crm::RemoteFieldRequest>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/merge_ruby_client/crm/types/patched_contact_request.rb', line 64

def initialize(first_name: OMIT, last_name: OMIT, account: OMIT, owner: OMIT, addresses: OMIT,
               email_addresses: OMIT, phone_numbers: OMIT, last_activity_at: OMIT, integration_params: OMIT, linked_account_params: OMIT, remote_fields: OMIT, additional_properties: nil)
  @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
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @remote_fields = remote_fields if remote_fields != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "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,
    "integration_params": integration_params,
    "linked_account_params": ,
    "remote_fields": remote_fields
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#account ⇒ String (readonly)

Returns The contact’s account.

Returns:

  • (String) —

    The contact’s account.



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

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



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

def additional_properties
  @additional_properties
end

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

Returns:



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

def addresses
  @addresses
end

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

Returns:



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

def email_addresses
  @email_addresses
end

#first_name ⇒ String (readonly)

Returns The contact’s first name.

Returns:

  • (String) —

    The contact’s first name.



22
23
24
 
# File 'lib/merge_ruby_client/crm/types/patched_contact_request.rb', line 22

def first_name
  @first_name
end

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

Returns:

  • (Hash{String => Object}) 


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

def integration_params
  @integration_params
end

#last_activity_at ⇒ DateTime (readonly)

Returns When the contact’s last activity occurred.

Returns:

  • (DateTime) —

    When the contact’s last activity occurred.



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

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.



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

def last_name
  @last_name
end

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

Returns:

  • (Hash{String => Object}) 


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

def 
  @linked_account_params
end

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

Returns The contact’s owner.

Returns:



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

def owner
  @owner
end

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

Returns:



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

def phone_numbers
  @phone_numbers
end

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

Returns:



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

def remote_fields
  @remote_fields
end

Class Method Details

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

Deserialize a JSON object to an instance of PatchedContactRequest

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  first_name = parsed_json["first_name"]
  last_name = parsed_json["last_name"]
   = parsed_json["account"]
  if parsed_json["owner"].nil?
    owner = nil
  else
    owner = parsed_json["owner"].to_json
    owner = Merge::Crm::PatchedContactRequestOwner.from_json(json_object: owner)
  end
  addresses = parsed_json["addresses"]&.map do |item|
    item = item.to_json
    Merge::Crm::AddressRequest.from_json(json_object: item)
  end
  email_addresses = parsed_json["email_addresses"]&.map do |item|
    item = item.to_json
    Merge::Crm::EmailAddressRequest.from_json(json_object: item)
  end
  phone_numbers = parsed_json["phone_numbers"]&.map do |item|
    item = item.to_json
    Merge::Crm::PhoneNumberRequest.from_json(json_object: item)
  end
  last_activity_at = (DateTime.parse(parsed_json["last_activity_at"]) unless parsed_json["last_activity_at"].nil?)
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  remote_fields = parsed_json["remote_fields"]&.map do |item|
    item = item.to_json
    Merge::Crm::RemoteFieldRequest.from_json(json_object: item)
  end
  new(
    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,
    integration_params: integration_params,
    linked_account_params: ,
    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) 


159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/merge_ruby_client/crm/types/patched_contact_request.rb', line 159

def self.validate_raw(obj:)
  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.&.is_a?(String) != false || raise("Passed value for field obj.account is not the expected type, validation failed.")
  obj.owner.nil? || Merge::Crm::PatchedContactRequestOwner.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.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params 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 PatchedContactRequest to a JSON object

Returns:

  • (String) 


149
150
151
 
# File 'lib/merge_ruby_client/crm/types/patched_contact_request.rb', line 149

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