Class: Knockapi::Models::Users::GuideMarkMessageAsArchivedParams

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

Overview

See Also:

  • Knockapi::Resources::Users::Guides#mark_message_as_archived

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(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, is_final: nil, tenant: nil, unthrottled: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Users::GuideMarkMessageAsArchivedParams for more details.

Parameters:

  • user_id (String)
  • message_id (String)
  • channel_id (String) —

    The unique identifier for the channel.

  • guide_id (String) —

    The unique identifier for the guide.

  • guide_key (String) —

    The key of the guide.

  • guide_step_ref (String) —

    The step reference of the guide.

  • is_final (Boolean) (defaults to: nil) —

    Whether the guide is final.

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

    The tenant ID of the guide.

  • unthrottled (Boolean) (defaults to: nil) —

    Whether the guide bypasses its guide group's throttle settings. When true, archi

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



# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 64

Instance Attribute Details

#channel_id ⇒ String

The unique identifier for the channel.

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 25

required :channel_id, String

#guide_id ⇒ String

The unique identifier for the guide.

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 31

required :guide_id, String

#guide_key ⇒ String

The key of the guide.

Parameters:

  • value (String)

Returns:

  • (String) 


37
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 37

required :guide_key, String

#guide_step_ref ⇒ String

The step reference of the guide.

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 43

required :guide_step_ref, String

#is_final ⇒ Boolean?

Whether the guide is final.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 49

optional :is_final, Knockapi::Internal::Type::Boolean

#message_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 19

required :message_id, String

#tenant ⇒ String?

The tenant ID of the guide.

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 55

optional :tenant, String

#unthrottled ⇒ Boolean?

Whether the guide bypasses its guide group's throttle settings. When true, archiving the guide does not open a new throttle window.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


62
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 62

optional :unthrottled, Knockapi::Internal::Type::Boolean

#user_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/knockapi/models/users/guide_mark_message_as_archived_params.rb', line 14

required :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs', line 59

def to_hash: -> {