Class: Knockapi::Models::Users::GuideGetChannelParams

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

Overview

See Also:

  • Knockapi::Resources::Users::Guides#get_channel

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:, channel_id:, data: nil, tenant: nil, type: nil, request_options: {}) ⇒ Object

Parameters:

  • user_id (String)
  • channel_id (String)
  • data (String) (defaults to: nil) —

    The data (JSON encoded object) to use for targeting and rendering guides.

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

    The tenant ID to use for targeting and rendering guides.

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

    The type of guides to filter by.

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



# File 'lib/knockapi/models/users/guide_get_channel_params.rb', line 39

Instance Attribute Details

#channel_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :channel_id, String

#data ⇒ String?

The data (JSON encoded object) to use for targeting and rendering guides.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :data, String

#tenant ⇒ String?

The tenant ID to use for targeting and rendering guides.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :tenant, String

#type ⇒ String?

The type of guides to filter by.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :type, String

#user_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


43
 
# File 'sig/knockapi/models/users/guide_get_channel_params.rbs', line 43

def to_hash: -> {