Class: Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/users/guide_get_channel_response.rb,
sig/knockapi/models/users/guide_get_channel_response.rbs

Defined Under Namespace

Modules: Reason

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(key:, message:, reason:) ⇒ Object

Parameters:




# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 365

Instance Attribute Details

#key ⇒ String

The guide's key identifier

Parameters:

  • value (String)

Returns:

  • (String) 


351
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 351

required :key, String

#message ⇒ String

Human-readable explanation of ineligibility

Parameters:

  • value (String)

Returns:

  • (String) 


357
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 357

required :message, String

#reason ⇒ Symbol, Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason

Reason code for ineligibility

Parameters:

  • value (Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::reason)

Returns:



363
 
# File 'lib/knockapi/models/users/guide_get_channel_response.rb', line 363

required :reason, enum: -> { Knockapi::Models::Users::GuideGetChannelResponse::IneligibleGuide::Reason }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


392
 
# File 'sig/knockapi/models/users/guide_get_channel_response.rbs', line 392

def to_hash: -> {