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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Dir::DirComment

Defined in:

lib/telnyx/models/dir/dir_comment.rb

Overview

See Also:

• Resources::Dir::Comments#list

Defined Under Namespace

Modules: AuthorRole, EntityType, Visibility

Instance Attribute Summary

• #comment_type ⇒ Symbol, ...

  Comment categorisation.

• #content ⇒ String^?

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id: nil, author_name: nil, author_role: nil, comment_type: nil, content: nil, created_at: nil, entity_type: nil, visibility: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see DirComment for more details.

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

#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:

• (Symbol, Telnyx::Models::Dir::CommentType, nil)

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

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

#content ⇒ String^?

Returns:

• (String, nil)

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

optional :content, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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