Class: VitableConnect::Models::EnrollmentTerminateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/vitable_connect/models/enrollment_terminate_params.rb,
sig/vitable_connect/models/enrollment_terminate_params.rbs

Overview

See Also:

  • VitableConnect::Resources::Enrollments#terminate

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(enrollment_id:, qualifying_life_event_id: nil, reason: nil, ticket_number: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::EnrollmentTerminateParams for more details.

Parameters:

  • enrollment_id (String) —

    Unique enrollment identifier (enrl_*)

  • qualifying_life_event_id (String, nil) (defaults to: nil) —

    Accepted member qualifying life event identifier (qle_*)

  • reason (String, nil) (defaults to: nil) —

    Audit reason for the termination; required for user-backed callers and optional

  • ticket_number (String, nil) (defaults to: nil) —

    Optional support or operational ticket number

  • request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/vitable_connect/models/enrollment_terminate_params.rb', line 35

Instance Attribute Details

#enrollment_id ⇒ String

Unique enrollment identifier (enrl_*)

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/vitable_connect/models/enrollment_terminate_params.rb', line 14

required :enrollment_id, String

#qualifying_life_event_id ⇒ String?

Accepted member qualifying life event identifier (qle_*)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


20
 
# File 'lib/vitable_connect/models/enrollment_terminate_params.rb', line 20

optional :qualifying_life_event_id, String, nil?: true

#reason ⇒ String?

Audit reason for the termination; required for user-backed callers and optional for userless organization callers

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


27
 
# File 'lib/vitable_connect/models/enrollment_terminate_params.rb', line 27

optional :reason, String, nil?: true

#ticket_number ⇒ String?

Optional support or operational ticket number

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


33
 
# File 'lib/vitable_connect/models/enrollment_terminate_params.rb', line 33

optional :ticket_number, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/vitable_connect/models/enrollment_terminate_params.rbs', line 32

def to_hash: -> {