Class: Merge::Ats::EmailAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/ats/types/email_address.rb

Overview

# The EmailAddress Object

### Description
The `EmailAddress` object is used to represent a candidate's email address.
### Usage Example
Fetch from the `GET Candidate` 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(created_at: OMIT, modified_at: OMIT, value: OMIT, email_address_type: OMIT, remote_was_deleted: OMIT, additional_properties: nil) ⇒ Merge::Ats::EmailAddress

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.

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

    The email address.

  • email_address_type (Merge::Ats::EmailAddressTypeEnum) (defaults to: OMIT) —

    The type of email address.

    • ‘PERSONAL` - PERSONAL

    • ‘WORK` - WORK

    • ‘OTHER` - OTHER

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform.

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

    Additional properties unmapped to the current class definition



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 49

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



31
32
33
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 31

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.



17
18
19
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 17

def created_at
  @created_at
end

#email_address_type ⇒ Merge::Ats::EmailAddressTypeEnum (readonly)

Returns The type of email address.

  • ‘PERSONAL` - PERSONAL

  • ‘WORK` - WORK

  • ‘OTHER` - OTHER.

Returns:



26
27
28
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 26

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



19
20
21
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 19

def modified_at
  @modified_at
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



29
30
31
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 29

def remote_was_deleted
  @remote_was_deleted
end

#value ⇒ String (readonly)

Returns The email address.

Returns:

  • (String) —

    The email address.



21
22
23
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 21

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Ats::EmailAddress

Deserialize a JSON object to an instance of EmailAddress

Parameters:

  • json_object (String)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 72

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?)
  value = parsed_json["value"]
  email_address_type = parsed_json["email_address_type"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  new(
    created_at: created_at,
    modified_at: modified_at,
    value: value,
    email_address_type: email_address_type,
    remote_was_deleted: remote_was_deleted,
    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) 


103
104
105
106
107
108
109
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 103

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of EmailAddress to a JSON object

Returns:

  • (String) 


93
94
95
 
# File 'lib/merge_ruby_client/ats/types/email_address.rb', line 93

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