Class: Merge::Ats::Offer

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

Overview

# The Offer Object

### Description
The `Offer` object is used to represent an offer for a candidate's application
specific to a job.
### Usage Example
Fetch from the `LIST Offers` endpoint and filter by `ID` to show all offers.

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, application: OMIT, creator: OMIT, remote_created_at: OMIT, closed_at: OMIT, sent_at: OMIT, start_date: OMIT, status: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ats::Offer

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.

  • application (Merge::Ats::OfferApplication) (defaults to: OMIT) —

    The application who is receiving the offer.

  • creator (Merge::Ats::OfferCreator) (defaults to: OMIT) —

    The user who created the offer.

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

    When the third party’s offer was created.

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

    When the offer was closed.

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

    When the offer was sent.

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

    The employment start date on the offer.

  • status (Merge::Ats::OfferStatusEnum) (defaults to: OMIT) —

    The offer’s status.

    • ‘DRAFT` - DRAFT

    • ‘APPROVAL-SENT` - APPROVAL-SENT

    • ‘APPROVED` - APPROVED

    • ‘SENT` - SENT

    • ‘SENT-MANUALLY` - SENT-MANUALLY

    • ‘OPENED` - OPENED

    • ‘DENIED` - DENIED

    • ‘SIGNED` - SIGNED

    • ‘DEPRECATED` - DEPRECATED

  • 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



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
123
124
125
126
127
 
# File 'lib/merge_ruby_client/ats/types/offer.rb', line 92

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, application: OMIT, creator: OMIT,
               remote_created_at: OMIT, closed_at: OMIT, sent_at: OMIT, start_date: OMIT, status: 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
  @application = application if application != OMIT
  @creator = creator if creator != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @closed_at = closed_at if closed_at != OMIT
  @sent_at = sent_at if sent_at != OMIT
  @start_date = start_date if start_date != OMIT
  @status = status if status != 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,
    "application": application,
    "creator": creator,
    "remote_created_at": remote_created_at,
    "closed_at": closed_at,
    "sent_at": sent_at,
    "start_date": start_date,
    "status": status,
    "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



59
60
61
 
# File 'lib/merge_ruby_client/ats/types/offer.rb', line 59

def additional_properties
  @additional_properties
end

#application ⇒ Merge::Ats::OfferApplication (readonly)

Returns The application who is receiving the offer.

Returns:



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

def application
  @application
end

#closed_at ⇒ DateTime (readonly)

Returns When the offer was closed.

Returns:

  • (DateTime) —

    When the offer was closed.



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

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



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

def created_at
  @created_at
end

#creator ⇒ Merge::Ats::OfferCreator (readonly)

Returns The user who created the offer.

Returns:



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

def creator
  @creator
end

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

Returns:

  • (Hash{String => Object}) 


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

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

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.



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

def modified_at
  @modified_at
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s offer was created.

Returns:

  • (DateTime) —

    When the third party’s offer was created.



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

def remote_created_at
  @remote_created_at
end

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

Returns:



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

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.



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

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.



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

def remote_was_deleted
  @remote_was_deleted
end

#sent_at ⇒ DateTime (readonly)

Returns When the offer was sent.

Returns:

  • (DateTime) —

    When the offer was sent.



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

def sent_at
  @sent_at
end

#start_date ⇒ DateTime (readonly)

Returns The employment start date on the offer.

Returns:

  • (DateTime) —

    The employment start date on the offer.



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

def start_date
  @start_date
end

#status ⇒ Merge::Ats::OfferStatusEnum (readonly)

Returns The offer’s status.

  • ‘DRAFT` - DRAFT

  • ‘APPROVAL-SENT` - APPROVAL-SENT

  • ‘APPROVED` - APPROVED

  • ‘SENT` - SENT

  • ‘SENT-MANUALLY` - SENT-MANUALLY

  • ‘OPENED` - OPENED

  • ‘DENIED` - DENIED

  • ‘SIGNED` - SIGNED

  • ‘DEPRECATED` - DEPRECATED.

Returns:

  • (Merge::Ats::OfferStatusEnum) —

    The offer’s status.

    • ‘DRAFT` - DRAFT

    • ‘APPROVAL-SENT` - APPROVAL-SENT

    • ‘APPROVED` - APPROVED

    • ‘SENT` - SENT

    • ‘SENT-MANUALLY` - SENT-MANUALLY

    • ‘OPENED` - OPENED

    • ‘DENIED` - DENIED

    • ‘SIGNED` - SIGNED

    • ‘DEPRECATED` - DEPRECATED



50
51
52
 
# File 'lib/merge_ruby_client/ats/types/offer.rb', line 50

def status
  @status
end

Class Method Details

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

Deserialize a JSON object to an instance of Offer

Parameters:

  • json_object (String)

Returns:



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
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/merge_ruby_client/ats/types/offer.rb', line 133

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["application"].nil?
    application = nil
  else
    application = parsed_json["application"].to_json
    application = Merge::Ats::OfferApplication.from_json(json_object: application)
  end
  if parsed_json["creator"].nil?
    creator = nil
  else
    creator = parsed_json["creator"].to_json
    creator = Merge::Ats::OfferCreator.from_json(json_object: creator)
  end
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  closed_at = (DateTime.parse(parsed_json["closed_at"]) unless parsed_json["closed_at"].nil?)
  sent_at = (DateTime.parse(parsed_json["sent_at"]) unless parsed_json["sent_at"].nil?)
  start_date = (DateTime.parse(parsed_json["start_date"]) unless parsed_json["start_date"].nil?)
  status = parsed_json["status"]
  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,
    application: application,
    creator: creator,
    remote_created_at: remote_created_at,
    closed_at: closed_at,
    sent_at: sent_at,
    start_date: start_date,
    status: status,
    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) 


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/merge_ruby_client/ats/types/offer.rb', line 197

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.application.nil? || Merge::Ats::OfferApplication.validate_raw(obj: obj.application)
  obj.creator.nil? || Merge::Ats::OfferCreator.validate_raw(obj: obj.creator)
  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.closed_at&.is_a?(DateTime) != false || raise("Passed value for field obj.closed_at is not the expected type, validation failed.")
  obj.sent_at&.is_a?(DateTime) != false || raise("Passed value for field obj.sent_at is not the expected type, validation failed.")
  obj.start_date&.is_a?(DateTime) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
  obj.status&.is_a?(Merge::Ats::OfferStatusEnum) != false || raise("Passed value for field obj.status 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 Offer to a JSON object

Returns:

  • (String) 


187
188
189
 
# File 'lib/merge_ruby_client/ats/types/offer.rb', line 187

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