Class: Merge::Ats::RemoteUser

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

Overview

# The RemoteUser Object

### Description
The `RemoteUser` object is used to represent a user with a login to the ATS
system.
### Usage Example
Fetch from the `LIST RemoteUsers` endpoint to show all users for a third party.

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, first_name: OMIT, last_name: OMIT, email: OMIT, disabled: OMIT, remote_created_at: OMIT, access_role: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ats::RemoteUser

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.

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

    The user’s first name.

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

    The user’s last name.

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

    The user’s email.

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

    Whether the user’s account had been disabled.

  • remote_created_at (DateTime) (defaults to: OMIT) —

    When the third party’s user was created.

  • access_role (Merge::Ats::AccessRoleEnum) (defaults to: OMIT) —

    The user’s role.

    • ‘SUPER_ADMIN` - SUPER_ADMIN

    • ‘ADMIN` - ADMIN

    • ‘TEAM_MEMBER` - TEAM_MEMBER

    • ‘LIMITED_TEAM_MEMBER` - LIMITED_TEAM_MEMBER

    • ‘INTERVIEWER` - INTERVIEWER

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

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

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Ats::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 79

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, first_name: OMIT, last_name: OMIT,
               email: OMIT, disabled: OMIT, remote_created_at: OMIT, access_role: 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
  @first_name = first_name if first_name != OMIT
  @last_name = last_name if last_name != OMIT
  @email = email if email != OMIT
  @disabled = disabled if disabled != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @access_role = access_role if access_role != 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,
    "first_name": first_name,
    "last_name": last_name,
    "email": email,
    "disabled": disabled,
    "remote_created_at": remote_created_at,
    "access_role": access_role,
    "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

#access_role ⇒ Merge::Ats::AccessRoleEnum (readonly)

Returns The user’s role.

  • ‘SUPER_ADMIN` - SUPER_ADMIN

  • ‘ADMIN` - ADMIN

  • ‘TEAM_MEMBER` - TEAM_MEMBER

  • ‘LIMITED_TEAM_MEMBER` - LIMITED_TEAM_MEMBER

  • ‘INTERVIEWER` - INTERVIEWER.

Returns:

  • (Merge::Ats::AccessRoleEnum) —

    The user’s role.

    • ‘SUPER_ADMIN` - SUPER_ADMIN

    • ‘ADMIN` - ADMIN

    • ‘TEAM_MEMBER` - TEAM_MEMBER

    • ‘LIMITED_TEAM_MEMBER` - LIMITED_TEAM_MEMBER

    • ‘INTERVIEWER` - INTERVIEWER



42
43
44
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 42

def access_role
  @access_role
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



51
52
53
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 51

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/ats/types/remote_user.rb', line 23

def created_at
  @created_at
end

#disabled ⇒ Boolean (readonly)

Returns Whether the user’s account had been disabled.

Returns:

  • (Boolean) —

    Whether the user’s account had been disabled.



33
34
35
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 33

def disabled
  @disabled
end

#email ⇒ String (readonly)

Returns The user’s email.

Returns:

  • (String) —

    The user’s email.



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

def email
  @email
end

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

Returns:

  • (Hash{String => Object}) 


47
48
49
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 47

def field_mappings
  @field_mappings
end

#first_name ⇒ String (readonly)

Returns The user’s first name.

Returns:

  • (String) —

    The user’s first name.



27
28
29
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 27

def first_name
  @first_name
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#last_name ⇒ String (readonly)

Returns The user’s last name.

Returns:

  • (String) —

    The user’s last name.



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

def last_name
  @last_name
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/ats/types/remote_user.rb', line 25

def modified_at
  @modified_at
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s user was created.

Returns:

  • (DateTime) —

    When the third party’s user was created.



35
36
37
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 35

def remote_created_at
  @remote_created_at
end

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

Returns:



49
50
51
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 49

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/ats/types/remote_user.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.

Returns:

  • (Boolean) —

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



45
46
47
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 45

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of RemoteUser

Parameters:

  • json_object (String)

Returns:



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
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 118

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?)
  first_name = parsed_json["first_name"]
  last_name = parsed_json["last_name"]
  email = parsed_json["email"]
  disabled = parsed_json["disabled"]
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  access_role = parsed_json["access_role"]
  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::Ats::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    first_name: first_name,
    last_name: last_name,
    email: email,
    disabled: disabled,
    remote_created_at: remote_created_at,
    access_role: access_role,
    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) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 170

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.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.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
  obj.disabled&.is_a?(Boolean) != false || raise("Passed value for field obj.disabled is not the expected type, validation failed.")
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.")
  obj.access_role&.is_a?(Merge::Ats::AccessRoleEnum) != false || raise("Passed value for field obj.access_role 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.")
  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 RemoteUser to a JSON object

Returns:

  • (String) 


160
161
162
 
# File 'lib/merge_ruby_client/ats/types/remote_user.rb', line 160

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