Class: Knockapi::Models::MessageMarkAsInteractedParams

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

Overview

See Also:

  • Knockapi::Resources::Messages#mark_as_interacted

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(message_id:, metadata: nil, request_options: {}) ⇒ Object

Parameters:

  • message_id (String)
  • metadata (Hash{Symbol=>Object}) (defaults to: nil)

    Metadata about the interaction.

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


# File 'lib/knockapi/models/message_mark_as_interacted_params.rb', line 21

Instance Attribute Details

#message_idString

Parameters:

  • value (String)

Returns:

  • (String)


13
# File 'lib/knockapi/models/message_mark_as_interacted_params.rb', line 13

required :message_id, String

#metadataHash{Symbol=>Object}?

Metadata about the interaction.

Parameters:

  • (::Hash[Symbol, top])

Returns:



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

optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]

Instance Method Details

#to_hash{

Returns:

  • ({)


23
# File 'sig/knockapi/models/message_mark_as_interacted_params.rbs', line 23

def to_hash: -> {