Class: Merge::Ats::Attachment

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

Overview

# The Attachment Object

### Description
The `Attachment` object is used to represent a file attached to a candidate.
### Usage Example
Fetch from the `LIST Attachments` endpoint and view attachments accessible by a
company.

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, file_name: OMIT, file_url: OMIT, candidate: OMIT, attachment_type: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ats::Attachment

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.

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

    The attachment’s name.

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

    The attachment’s url.

  • candidate (String) (defaults to: OMIT)
  • attachment_type (Merge::Ats::AttachmentTypeEnum) (defaults to: OMIT) —

    The attachment’s type.

    • ‘RESUME` - RESUME

    • ‘COVER_LETTER` - COVER_LETTER

    • ‘OFFER_LETTER` - OFFER_LETTER

    • ‘OTHER` - OTHER

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

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • 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



75
76
77
78
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
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 75

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, file_name: OMIT, file_url: OMIT,
               candidate: OMIT, attachment_type: 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
  @file_name = file_name if file_name != OMIT
  @file_url = file_url if file_url != OMIT
  @candidate = candidate if candidate != OMIT
  @attachment_type = attachment_type if attachment_type != 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,
    "file_name": file_name,
    "file_url": file_url,
    "candidate": candidate,
    "attachment_type": attachment_type,
    "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

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

#attachment_type ⇒ Merge::Ats::AttachmentTypeEnum (readonly)

Returns The attachment’s type.

  • ‘RESUME` - RESUME

  • ‘COVER_LETTER` - COVER_LETTER

  • ‘OFFER_LETTER` - OFFER_LETTER

  • ‘OTHER` - OTHER.

Returns:

  • (Merge::Ats::AttachmentTypeEnum) —

    The attachment’s type.

    • ‘RESUME` - RESUME

    • ‘COVER_LETTER` - COVER_LETTER

    • ‘OFFER_LETTER` - OFFER_LETTER

    • ‘OTHER` - OTHER



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

def attachment_type
  @attachment_type
end

#candidate ⇒ String (readonly)

Returns:

  • (String) 


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

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.



23
24
25
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 23

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


44
45
46
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 44

def field_mappings
  @field_mappings
end

#file_name ⇒ String (readonly)

Returns The attachment’s name.

Returns:

  • (String) —

    The attachment’s name.



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

def file_name
  @file_name
end

#file_url ⇒ String (readonly)

Returns The attachment’s url.

Returns:

  • (String) —

    The attachment’s url.



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

def file_url
  @file_url
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

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.



25
26
27
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 25

def modified_at
  @modified_at
end

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

Returns:



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

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/attachment.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. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of Attachment

Parameters:

  • json_object (String)

Returns:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 110

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?)
  file_name = parsed_json["file_name"]
  file_url = parsed_json["file_url"]
  candidate = parsed_json["candidate"]
  attachment_type = parsed_json["attachment_type"]
  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,
    file_name: file_name,
    file_url: file_url,
    candidate: candidate,
    attachment_type: attachment_type,
    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) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 156

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.file_name&.is_a?(String) != false || raise("Passed value for field obj.file_name is not the expected type, validation failed.")
  obj.file_url&.is_a?(String) != false || raise("Passed value for field obj.file_url 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.attachment_type&.is_a?(Merge::Ats::AttachmentTypeEnum) != false || raise("Passed value for field obj.attachment_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.")
  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 Attachment to a JSON object

Returns:

  • (String) 


146
147
148
 
# File 'lib/merge_ruby_client/ats/types/attachment.rb', line 146

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