Class: Merge::Crm::PhoneNumber

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

Overview

The PhoneNumber Object

Description

The PhoneNumber object is used to represent an entity's phone number.

Usage Example

Fetch from the GET Contact endpoint and view their phone numbers.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(created_at: OMIT, modified_at: OMIT, phone_number: OMIT, phone_number_type: OMIT, additional_properties: nil) ⇒ Merge::Crm::PhoneNumber

Parameters:

  • 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.

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

    The phone number.

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

    The phone number's type.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 37

def initialize(created_at: OMIT, modified_at: OMIT, phone_number: OMIT, phone_number_type: OMIT,
               additional_properties: nil)
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @phone_number = phone_number if phone_number != OMIT
  @phone_number_type = phone_number_type if phone_number_type != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "created_at": created_at,
    "modified_at": modified_at,
    "phone_number": phone_number,
    "phone_number_type": phone_number_type
  }.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



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

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.



16
17
18
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 16

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



18
19
20
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 18

def modified_at
  @modified_at
end

#phone_number ⇒ String (readonly)

Returns The phone number.

Returns:

  • (String) —

    The phone number.



20
21
22
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 20

def phone_number
  @phone_number
end

#phone_number_type ⇒ String (readonly)

Returns The phone number's type.

Returns:

  • (String) —

    The phone number's type.



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

def phone_number_type
  @phone_number_type
end

Class Method Details

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

Deserialize a JSON object to an instance of PhoneNumber

Parameters:

  • json_object (String)

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 58

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  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?)
  phone_number = parsed_json["phone_number"]
  phone_number_type = parsed_json["phone_number_type"]
  new(
    created_at: created_at,
    modified_at: modified_at,
    phone_number: phone_number,
    phone_number_type: phone_number_type,
    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) 


87
88
89
90
91
92
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 87

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of PhoneNumber to a JSON object

Returns:

  • (String) 


77
78
79
 
# File 'lib/merge_ruby_client/crm/types/phone_number.rb', line 77

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