Class: Merge::Ats::Activity

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

Overview

# The Activity Object

### Description
The `Activity` object is used to represent an activity for a candidate performed
by a user.
### Usage Example
Fetch from the `LIST Activities` endpoint and filter by `ID` to show all
activities.

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, user: OMIT, remote_created_at: OMIT, activity_type: OMIT, subject: OMIT, body: OMIT, visibility: OMIT, candidate: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ats::Activity

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.

  • user (Merge::Ats::ActivityUser) (defaults to: OMIT) —

    The user that performed the action.

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

    When the third party’s activity was created.

  • activity_type (Merge::Ats::ActivityTypeEnum) (defaults to: OMIT) —

    The activity’s type.

    • ‘NOTE` - NOTE

    • ‘EMAIL` - EMAIL

    • ‘OTHER` - OTHER

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

    The activity’s subject.

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

    The activity’s body.

  • visibility (Merge::Ats::VisibilityEnum) (defaults to: OMIT) —

    The activity’s visibility.

    • ‘ADMIN_ONLY` - ADMIN_ONLY

    • ‘PUBLIC` - PUBLIC

    • ‘PRIVATE` - PRIVATE

  • candidate (String) (defaults to: OMIT)
  • 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



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
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 87

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, user: OMIT,
               remote_created_at: OMIT, activity_type: OMIT, subject: OMIT, body: OMIT, visibility: OMIT, candidate: 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
  @user = user if user != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @activity_type = activity_type if activity_type != OMIT
  @subject = subject if subject != OMIT
  @body = body if body != OMIT
  @visibility = visibility if visibility != OMIT
  @candidate = candidate if candidate != 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,
    "user": user,
    "remote_created_at": remote_created_at,
    "activity_type": activity_type,
    "subject": subject,
    "body": body,
    "visibility": visibility,
    "candidate": candidate,
    "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

#activity_type ⇒ Merge::Ats::ActivityTypeEnum (readonly)

Returns The activity’s type.

  • ‘NOTE` - NOTE

  • ‘EMAIL` - EMAIL

  • ‘OTHER` - OTHER.

Returns:



37
38
39
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 37

def activity_type
  @activity_type
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



57
58
59
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 57

def additional_properties
  @additional_properties
end

#body ⇒ String (readonly)

Returns The activity’s body.

Returns:

  • (String) —

    The activity’s body.



41
42
43
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 41

def body
  @body
end

#candidate ⇒ String (readonly)

Returns:

  • (String) 


48
49
50
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 48

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



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

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


53
54
55
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 53

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 22

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.



28
29
30
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 28

def modified_at
  @modified_at
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s activity was created.

Returns:

  • (DateTime) —

    When the third party’s activity was created.



32
33
34
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 32

def remote_created_at
  @remote_created_at
end

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

Returns:



55
56
57
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 55

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.



24
25
26
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 24

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.



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

def remote_was_deleted
  @remote_was_deleted
end

#subject ⇒ String (readonly)

Returns The activity’s subject.

Returns:

  • (String) —

    The activity’s subject.



39
40
41
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 39

def subject
  @subject
end

#user ⇒ Merge::Ats::ActivityUser (readonly)

Returns The user that performed the action.

Returns:



30
31
32
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 30

def user
  @user
end

#visibility ⇒ Merge::Ats::VisibilityEnum (readonly)

Returns The activity’s visibility.

  • ‘ADMIN_ONLY` - ADMIN_ONLY

  • ‘PUBLIC` - PUBLIC

  • ‘PRIVATE` - PRIVATE.

Returns:

  • (Merge::Ats::VisibilityEnum) —

    The activity’s visibility.

    • ‘ADMIN_ONLY` - ADMIN_ONLY

    • ‘PUBLIC` - PUBLIC

    • ‘PRIVATE` - PRIVATE



46
47
48
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 46

def visibility
  @visibility
end

Class Method Details

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

Deserialize a JSON object to an instance of Activity

Parameters:

  • json_object (String)

Returns:



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 128

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?)
  if parsed_json["user"].nil?
    user = nil
  else
    user = parsed_json["user"].to_json
    user = Merge::Ats::ActivityUser.from_json(json_object: user)
  end
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  activity_type = parsed_json["activity_type"]
  subject = parsed_json["subject"]
  body = parsed_json["body"]
  visibility = parsed_json["visibility"]
  candidate = parsed_json["candidate"]
  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,
    user: user,
    remote_created_at: remote_created_at,
    activity_type: activity_type,
    subject: subject,
    body: body,
    visibility: visibility,
    candidate: candidate,
    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) 


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 187

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.user.nil? || Merge::Ats::ActivityUser.validate_raw(obj: obj.user)
  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.activity_type&.is_a?(Merge::Ats::ActivityTypeEnum) != false || raise("Passed value for field obj.activity_type is not the expected type, validation failed.")
  obj.subject&.is_a?(String) != false || raise("Passed value for field obj.subject is not the expected type, validation failed.")
  obj.body&.is_a?(String) != false || raise("Passed value for field obj.body is not the expected type, validation failed.")
  obj.visibility&.is_a?(Merge::Ats::VisibilityEnum) != false || raise("Passed value for field obj.visibility is not the expected type, validation failed.")
  obj.candidate&.is_a?(String) != false || raise("Passed value for field obj.candidate 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 Activity to a JSON object

Returns:

  • (String) 


177
178
179
 
# File 'lib/merge_ruby_client/ats/types/activity.rb', line 177

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