Class: ContextDev::Models::BatchSubmitResponse::Person::Education

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/batch_submit_response.rb,
sig/context_dev/models/batch_submit_response.rbs

Defined Under Namespace

Classes: Dates, Institution

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(display_:, normalized: nil) ⇒ Object

School or institution name.

Parameters:

  • display_ (String) —

    Display name.

  • normalized (String) (defaults to: nil) —

    Standardized name, when available.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/context_dev/models/batch_submit_response.rb', line 194

class Education < ContextDev::Internal::Type::BaseModel
  # @!attribute institution
  #   School or institution name.
  #
  #   @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Institution]
  required :institution, -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Institution }

  # @!attribute dates
  #   Education dates.
  #
  #   @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates, nil]
  optional :dates, -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates }

  # @!attribute description
  #   Additional education details.
  #
  #   @return [String, nil]
  optional :description, String

  # @!attribute field_of_study
  #   Area of study.
  #
  #   @return [String, nil]
  optional :field_of_study, String, api_name: :fieldOfStudy

  # @!attribute qualification
  #   Degree, certificate, or credential.
  #
  #   @return [String, nil]
  optional :qualification, String

  # @!method initialize(institution:, dates: nil, description: nil, field_of_study: nil, qualification: nil)
  #   @param institution [ContextDev::Models::BatchSubmitResponse::Person::Education::Institution] School or institution name.
  #
  #   @param dates [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates] Education dates.
  #
  #   @param description [String] Additional education details.
  #
  #   @param field_of_study [String] Area of study.
  #
  #   @param qualification [String] Degree, certificate, or credential.

  # @see ContextDev::Models::BatchSubmitResponse::Person::Education#institution
  class Institution < ContextDev::Internal::Type::BaseModel
    # @!attribute display_
    #   Display name.
    #
    #   @return [String]
    required :display_, String, api_name: :display

    # @!attribute normalized
    #   Standardized name, when available.
    #
    #   @return [String, nil]
    optional :normalized, String

    # @!method initialize(display_:, normalized: nil)
    #   School or institution name.
    #
    #   @param display_ [String] Display name.
    #
    #   @param normalized [String] Standardized name, when available.
  end

  # @see ContextDev::Models::BatchSubmitResponse::Person::Education#dates
  class Dates < ContextDev::Internal::Type::BaseModel
    # @!attribute end_date
    #   End date, when known.
    #
    #   @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::EndDate, nil]
    optional :end_date,
             -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::EndDate },
             api_name: :endDate

    # @!attribute is_current
    #   Whether the entry is current.
    #
    #   @return [Boolean, nil]
    optional :is_current, ContextDev::Internal::Type::Boolean, api_name: :isCurrent

    # @!attribute start_date
    #   Start date, when known.
    #
    #   @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::StartDate, nil]
    optional :start_date,
             -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::StartDate },
             api_name: :startDate

    # @!method initialize(end_date: nil, is_current: nil, start_date: nil)
    #   Education dates.
    #
    #   @param end_date [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::EndDate] End date, when known.
    #
    #   @param is_current [Boolean] Whether the entry is current.
    #
    #   @param start_date [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::StartDate] Start date, when known.

    # @see ContextDev::Models::BatchSubmitResponse::Person::Education::Dates#end_date
    class EndDate < ContextDev::Internal::Type::BaseModel
      # @!attribute year
      #   Year value.
      #
      #   @return [Integer]
      required :year, Integer

      # @!attribute day
      #   Day value, when known.
      #
      #   @return [Integer, nil]
      optional :day, Integer

      # @!attribute month
      #   Month value, when known.
      #
      #   @return [Integer, nil]
      optional :month, Integer

      # @!method initialize(year:, day: nil, month: nil)
      #   End date, when known.
      #
      #   @param year [Integer] Year value.
      #
      #   @param day [Integer] Day value, when known.
      #
      #   @param month [Integer] Month value, when known.
    end

    # @see ContextDev::Models::BatchSubmitResponse::Person::Education::Dates#start_date
    class StartDate < ContextDev::Internal::Type::BaseModel
      # @!attribute year
      #   Year value.
      #
      #   @return [Integer]
      required :year, Integer

      # @!attribute day
      #   Day value, when known.
      #
      #   @return [Integer, nil]
      optional :day, Integer

      # @!attribute month
      #   Month value, when known.
      #
      #   @return [Integer, nil]
      optional :month, Integer

      # @!method initialize(year:, day: nil, month: nil)
      #   Start date, when known.
      #
      #   @param year [Integer] Year value.
      #
      #   @param day [Integer] Day value, when known.
      #
      #   @param month [Integer] Month value, when known.
    end
  end
end

Instance Attribute Details

#dates ⇒ ContextDev::Models::BatchSubmitResponse::Person::Education::Dates?

Education dates.

Returns:



205
 
# File 'lib/context_dev/models/batch_submit_response.rb', line 205

optional :dates, -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates }

#description ⇒ String?

Additional education details.

Parameters:

  • (String)

Returns:

  • (String, nil) 


211
 
# File 'lib/context_dev/models/batch_submit_response.rb', line 211

optional :description, String

#field_of_study ⇒ String?

Area of study.

Parameters:

  • (String)

Returns:

  • (String, nil) 


217
 
# File 'lib/context_dev/models/batch_submit_response.rb', line 217

optional :field_of_study, String, api_name: :fieldOfStudy

#institution ⇒ ContextDev::Models::BatchSubmitResponse::Person::Education::Institution

School or institution name.

Parameters:

Returns:



199
 
# File 'lib/context_dev/models/batch_submit_response.rb', line 199

required :institution, -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Institution }

#qualification ⇒ String?

Degree, certificate, or credential.

Parameters:

  • (String)

Returns:

  • (String, nil) 


223
 
# File 'lib/context_dev/models/batch_submit_response.rb', line 223

optional :qualification, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


201
 
# File 'sig/context_dev/models/batch_submit_response.rbs', line 201

def to_hash: -> {