Class: Knockapi::Models::Recipients::RecipientsChannelData

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

Defined Under Namespace

Modules: Data, Provider

Instance Attribute Summary collapse

Class Method 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(target_arn:, locale: nil, timezone: nil) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull::Device for more details.

Parameters:

  • target_arn (String) —

    The ARN of a platform endpoint associated with a platform application and a devi

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

    The locale of the object. Used for [message localization](/concepts/translations

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

    The timezone of the object. Must be a valid [tz database time zone string](https




# File 'lib/knockapi/models/recipients/channel_data.rb', line 31

Instance Attribute Details

#_typename ⇒ String

The typename of the schema.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 11

required :_typename, String, api_name: :__typename

#channel_id ⇒ String

The unique identifier for the channel.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 17

required :channel_id, String

#data ⇒ Knockapi::Models::Recipients::RecipientsChannelData::Data::PushChannelDataFull, ...

Channel data for a given channel type.

Parameters:

  • value (Knockapi::Models::Recipients::RecipientsChannelData::data)

Returns:



23
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 23

required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data }

#provider ⇒ Symbol, ...

The type of provider.

Returns:



29
 
# File 'lib/knockapi/models/recipients/channel_data.rb', line 29

optional :provider, enum: -> { Knockapi::Recipients::RecipientsChannelData::Provider }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/knockapi/models/recipients/channel_data.rbs', line 32

def to_hash: -> {