Class: Telnyx::Models::NotificationChannel

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/notification_channel.rb,
sig/telnyx/models/notification_channel.rbs

Overview

See Also:

  • Telnyx::Resources::NotificationChannels#list

Defined Under Namespace

Modules: ChannelTypeID

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(id: nil, channel_destination: nil, channel_type_id: nil, created_at: nil, notification_profile_id: nil, updated_at: nil) ⇒ Object

A Notification Channel

Parameters:

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

    A UUID.

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

    The destination associated with the channel type.

  • channel_type_id (Symbol, Telnyx::Models::NotificationChannel::ChannelTypeID) (defaults to: nil) —

    A Channel Type ID

  • created_at (Time) (defaults to: nil) —

    ISO 8601 formatted date indicating when the resource was created.

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

    A UUID reference to the associated Notification Profile.

  • updated_at (Time) (defaults to: nil) —

    ISO 8601 formatted date indicating when the resource was updated.




# File 'lib/telnyx/models/notification_channel.rb', line 45

Instance Attribute Details

#channel_destination ⇒ String?

The destination associated with the channel type.

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/telnyx/models/notification_channel.rb', line 11

optional :channel_destination, String

#channel_type_id ⇒ Symbol, ...

A Channel Type ID

Returns:



17
 
# File 'lib/telnyx/models/notification_channel.rb', line 17

optional :channel_type_id, enum: -> { Telnyx::NotificationChannel::ChannelTypeID }

#created_at ⇒ Time? (readonly)

Returns the value of attribute created_at.

Returns:

  • (Time, nil) 


32
33
34
 
# File 'sig/telnyx/models/notification_channel.rbs', line 32

def created_at
  @created_at
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


28
29
30
 
# File 'sig/telnyx/models/notification_channel.rbs', line 28

def id
  @id
end

#notification_profile_id ⇒ String?

A UUID reference to the associated Notification Profile.

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/telnyx/models/notification_channel.rb', line 23

optional :notification_profile_id, String

#updated_at ⇒ Time? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (Time, nil) 


36
37
38
 
# File 'sig/telnyx/models/notification_channel.rbs', line 36

def updated_at
  @updated_at
end

Instance Method Details

#created_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


34
 
# File 'sig/telnyx/models/notification_channel.rbs', line 34

def created_at=: (Time) -> Time

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


30
 
# File 'sig/telnyx/models/notification_channel.rbs', line 30

def id=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


49
 
# File 'sig/telnyx/models/notification_channel.rbs', line 49

def to_hash: -> {

#updated_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


38
 
# File 'sig/telnyx/models/notification_channel.rbs', line 38

def updated_at=: (Time) -> Time