Class: Merge::Crm::EmailAddressRequest

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

Overview

The EmailAddress Object

Description

The EmailAddress object is used to represent an entity's email address.

Usage Example

Fetch from the GET Contact endpoint and view their email addresses.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_address: OMIT, email_address_type: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Crm::EmailAddressRequest

Parameters:

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

    The email address.

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

    The email address's type.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(email_address: OMIT, email_address_type: OMIT, integration_params: OMIT,
               linked_account_params: OMIT, additional_properties: nil)
  @email_address = email_address if email_address != OMIT
  @email_address_type = email_address_type if email_address_type != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "email_address": email_address,
    "email_address_type": email_address_type,
    "integration_params": integration_params,
    "linked_account_params": 
  }.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



23
24
25
 
# File 'lib/merge_ruby_client/crm/types/email_address_request.rb', line 23

def additional_properties
  @additional_properties
end

#email_address ⇒ String (readonly)

Returns The email address.

Returns:

  • (String) —

    The email address.



15
16
17
 
# File 'lib/merge_ruby_client/crm/types/email_address_request.rb', line 15

def email_address
  @email_address
end

#email_address_type ⇒ String (readonly)

Returns The email address's type.

Returns:

  • (String) —

    The email address's type.



17
18
19
 
# File 'lib/merge_ruby_client/crm/types/email_address_request.rb', line 17

def email_address_type
  @email_address_type
end

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

Returns:

  • (Hash{String => Object}) 


19
20
21
 
# File 'lib/merge_ruby_client/crm/types/email_address_request.rb', line 19

def integration_params
  @integration_params
end

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

Returns:

  • (Hash{String => Object}) 


21
22
23
 
# File 'lib/merge_ruby_client/crm/types/email_address_request.rb', line 21

def 
  @linked_account_params
end

Class Method Details

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

Deserialize a JSON object to an instance of EmailAddressRequest

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  email_address = parsed_json["email_address"]
  email_address_type = parsed_json["email_address_type"]
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  new(
    email_address: email_address,
    email_address_type: email_address_type,
    integration_params: integration_params,
    linked_account_params: ,
    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) 


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

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of EmailAddressRequest to a JSON object

Returns:

  • (String) 


76
77
78
 
# File 'lib/merge_ruby_client/crm/types/email_address_request.rb', line 76

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