Class: Telnyx::Models::CommentListResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/comment_list_response.rb

Defined Under Namespace

Modules: CommentRecordType, CommenterType

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, body: nil, comment_record_id: nil, comment_record_type: nil, commenter: nil, commenter_type: nil, created_at: nil, read_at: nil, updated_at: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: nil)
  • body (String) (defaults to: nil)
  • comment_record_id (String) (defaults to: nil)
  • comment_record_type (Symbol, Telnyx::Models::CommentListResponse::Data::CommentRecordType) (defaults to: nil)
  • commenter (String) (defaults to: nil)
  • commenter_type (Symbol, Telnyx::Models::CommentListResponse::Data::CommenterType) (defaults to: nil)
  • created_at (Time) (defaults to: nil)

    An ISO 8901 datetime string denoting when the comment was created.

  • read_at (Time) (defaults to: nil)

    An ISO 8901 datetime string for when the comment was read.

  • updated_at (Time) (defaults to: nil)

    An ISO 8901 datetime string for when the comment was updated.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/telnyx/models/comment_list_response.rb', line 21

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute body
  #
  #   @return [String, nil]
  optional :body, String

  # @!attribute comment_record_id
  #
  #   @return [String, nil]
  optional :comment_record_id, String

  # @!attribute comment_record_type
  #
  #   @return [Symbol, Telnyx::Models::CommentListResponse::Data::CommentRecordType, nil]
  optional :comment_record_type, enum: -> { Telnyx::Models::CommentListResponse::Data::CommentRecordType }

  response_only do
    # @!attribute id
    #
    #   @return [String, nil]
    optional :id, String

    # @!attribute commenter
    #
    #   @return [String, nil]
    optional :commenter, String

    # @!attribute commenter_type
    #
    #   @return [Symbol, Telnyx::Models::CommentListResponse::Data::CommenterType, nil]
    optional :commenter_type, enum: -> { Telnyx::Models::CommentListResponse::Data::CommenterType }

    # @!attribute created_at
    #   An ISO 8901 datetime string denoting when the comment was created.
    #
    #   @return [Time, nil]
    optional :created_at, Time

    # @!attribute read_at
    #   An ISO 8901 datetime string for when the comment was read.
    #
    #   @return [Time, nil]
    optional :read_at, Time

    # @!attribute updated_at
    #   An ISO 8901 datetime string for when the comment was updated.
    #
    #   @return [Time, nil]
    optional :updated_at, Time
  end

  # @!method initialize(id: nil, body: nil, comment_record_id: nil, comment_record_type: nil, commenter: nil, commenter_type: nil, created_at: nil, read_at: nil, updated_at: nil)
  #   @param id [String]
  #
  #   @param body [String]
  #
  #   @param comment_record_id [String]
  #
  #   @param comment_record_type [Symbol, Telnyx::Models::CommentListResponse::Data::CommentRecordType]
  #
  #   @param commenter [String]
  #
  #   @param commenter_type [Symbol, Telnyx::Models::CommentListResponse::Data::CommenterType]
  #
  #   @param created_at [Time] An ISO 8901 datetime string denoting when the comment was created.
  #
  #   @param read_at [Time] An ISO 8901 datetime string for when the comment was read.
  #
  #   @param updated_at [Time] An ISO 8901 datetime string for when the comment was updated.

  # @see Telnyx::Models::CommentListResponse::Data#comment_record_type
  module CommentRecordType
    extend Telnyx::Internal::Type::Enum

    SUB_NUMBER_ORDER = :sub_number_order
    REQUIREMENT_GROUP = :requirement_group

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Telnyx::Models::CommentListResponse::Data#commenter_type
  module CommenterType
    extend Telnyx::Internal::Type::Enum

    ADMIN = :admin
    USER = :user

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#bodyString?

Returns:

  • (String, nil)


25
# File 'lib/telnyx/models/comment_list_response.rb', line 25

optional :body, String

#comment_record_idString?

Returns:

  • (String, nil)


30
# File 'lib/telnyx/models/comment_list_response.rb', line 30

optional :comment_record_id, String

#comment_record_typeSymbol, ...



35
# File 'lib/telnyx/models/comment_list_response.rb', line 35

optional :comment_record_type, enum: -> { Telnyx::Models::CommentListResponse::Data::CommentRecordType }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/telnyx/models/comment_list_response.rb', line 98