Class: Merge::Ticketing::Contact

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

Overview

# The Contact Object

### Description
The `Contact` object is used to represent the customer, lead, or external user
that a ticket is associated with.
### 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, name: OMIT, email_address: OMIT, phone_number: OMIT, details: OMIT, account: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ticketing::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.

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

    The contact’s email address.

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

    The contact’s phone number.

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

    The contact’s details.

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

    The contact’s account.

  • 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::Ticketing::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 70

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, email_address: OMIT,
               phone_number: OMIT, details: OMIT, account: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: 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
  @email_address = email_address if email_address != OMIT
  @phone_number = phone_number if phone_number != OMIT
  @details = details if details != OMIT
  @account =  if  != 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
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "name": name,
    "email_address": email_address,
    "phone_number": phone_number,
    "details": details,
    "account": ,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

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

Returns The contact’s account.

Returns:



35
36
37
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 35

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



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

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



23
24
25
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 23

def created_at
  @created_at
end

#details ⇒ String (readonly)

Returns The contact’s details.

Returns:

  • (String) —

    The contact’s details.



33
34
35
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 33

def details
  @details
end

#email_address ⇒ String (readonly)

Returns The contact’s email address.

Returns:

  • (String) —

    The contact’s email address.



29
30
31
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 29

def email_address
  @email_address
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 19

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



25
26
27
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 25

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The contact’s name.

Returns:

  • (String) —

    The contact’s name.



27
28
29
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 27

def name
  @name
end

#phone_number ⇒ String (readonly)

Returns The contact’s phone number.

Returns:

  • (String) —

    The contact’s phone number.



31
32
33
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 31

def phone_number
  @phone_number
end

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

Returns:



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

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



21
22
23
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 21

def remote_id
  @remote_id
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/).



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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of Contact

Parameters:

  • json_object (String)

Returns:



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

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"]
  email_address = parsed_json["email_address"]
  phone_number = parsed_json["phone_number"]
  details = parsed_json["details"]
  if parsed_json["account"].nil?
     = nil
  else
     = parsed_json["account"].to_json
     = Merge::Ticketing::ContactAccount.from_json(json_object: )
  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::Ticketing::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    email_address: email_address,
    phone_number: phone_number,
    details: details,
    account: ,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    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) 


160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 160

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.email_address&.is_a?(String) != false || raise("Passed value for field obj.email_address is not the expected type, validation failed.")
  obj.phone_number&.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
  obj.details&.is_a?(String) != false || raise("Passed value for field obj.details is not the expected type, validation failed.")
  obj..nil? || Merge::Ticketing::ContactAccount.validate_raw(obj: obj.)
  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.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Contact to a JSON object

Returns:

  • (String) 


150
151
152
 
# File 'lib/merge_ruby_client/ticketing/types/contact.rb', line 150

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