Class: Telnyx::Models::Dir::DirComment

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

Overview

See Also:

  • Telnyx::Resources::Dir::Comments#list

Defined Under Namespace

Modules: AuthorRole, EntityType, Visibility

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(id: nil, author_name: nil, author_role: nil, comment_type: nil, content: nil, created_at: nil, entity_type: nil, visibility: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Dir::DirComment for more details.

Parameters:

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

    Display name of the author. May be null.

  • author_role (Symbol, Telnyx::Models::Dir::DirComment::AuthorRole) (defaults to: nil) —

    Who wrote the comment. admin covers the Telnyx vetting team.

  • comment_type (Symbol, Telnyx::Models::Dir::CommentType) (defaults to: nil) —

    Comment categorisation. Customers post customer_inquiry. The Telnyx team posts

  • content (String) (defaults to: nil)
  • created_at (Time) (defaults to: nil)
  • entity_type (Symbol, Telnyx::Models::Dir::DirComment::EntityType) (defaults to: nil) —

    Resource the comment is attached to. Always dir on this endpoint.

  • visibility (Symbol, Telnyx::Models::Dir::DirComment::Visibility) (defaults to: nil) —

    Always customer on this endpoint - internal-only comments are filtered out.




# File 'lib/telnyx/models/dir/dir_comment.rb', line 57

Instance Attribute Details

#author_name ⇒ String?

Returns the value of attribute author_name.

Returns:

  • (String, nil) 


33
34
35
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 33

def author_name
  @author_name
end

#author_role ⇒ Telnyx::Models::Dir::DirComment::author_role? (readonly)

Returns the value of attribute author_role.

Returns:

  • (Telnyx::Models::Dir::DirComment::author_role, nil) 


35
36
37
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 35

def author_role
  @author_role
end

#comment_type ⇒ Symbol, ...

Comment categorisation. Customers post customer_inquiry. The Telnyx team posts vetting_comment, rejection_reason, notification, status_update, or admin_response. internal_note is filtered out of customer-visible responses.

Returns:



14
 
# File 'lib/telnyx/models/dir/dir_comment.rb', line 14

optional :comment_type, enum: -> { Telnyx::Dir::CommentType }

#content ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


19
 
# File 'lib/telnyx/models/dir/dir_comment.rb', line 19

optional :content, String

#created_at ⇒ Time? (readonly)

Returns the value of attribute created_at.

Returns:

  • (Time, nil) 


41
42
43
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 41

def created_at
  @created_at
end

#entity_type ⇒ Telnyx::Models::Dir::DirComment::entity_type? (readonly)

Returns the value of attribute entity_type.

Returns:

  • (Telnyx::Models::Dir::DirComment::entity_type, nil) 


45
46
47
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 45

def entity_type
  @entity_type
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


29
30
31
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 29

def id
  @id
end

#visibility ⇒ Telnyx::Models::Dir::DirComment::visibility? (readonly)

Returns the value of attribute visibility.

Returns:

  • (Telnyx::Models::Dir::DirComment::visibility, nil) 


51
52
53
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 51

def visibility
  @visibility
end

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/dir/dir_comment.rb', line 86

Instance Method Details

#author_role= ⇒ Object (readonly) 



37
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 37

def author_role=: (

#created_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


43
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 43

def created_at=: (Time) -> Time

#entity_type= ⇒ Object (readonly) 



47
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 47

def entity_type=: (

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


31
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 31

def id=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 68

def to_hash: -> {

#visibility= ⇒ Object (readonly) 



53
 
# File 'sig/telnyx/models/dir/dir_comment.rbs', line 53

def visibility=: (