Class: Telnyx::Models::Dir::CommentListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/dir/comment_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: CommentType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(dir_id:, comment_type: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Restrict to comments of this category. Customer-visible categories only: interna

  • page_number (Integer) (defaults to: nil) —

    1-based page number. Out-of-range values return an empty page with correct meta.

  • page_size (Integer) (defaults to: nil) —

    Items per page. Maximum 250; values above are clamped to 250.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#comment_type ⇒ Symbol, ...

Restrict to comments of this category. Customer-visible categories only: internal-only comments are filtered out regardless of this filter.

Returns:



21
 
# File 'lib/telnyx/models/dir/comment_list_params.rb', line 21

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

#dir_id ⇒ String

Returns:

  • (String) 


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

required :dir_id, String

#page_number ⇒ Integer?

1-based page number. Out-of-range values return an empty page with correct meta.

Returns:

  • (Integer, nil) 


27
 
# File 'lib/telnyx/models/dir/comment_list_params.rb', line 27

optional :page_number, Integer

#page_size ⇒ Integer?

Items per page. Maximum 250; values above are clamped to 250.

Returns:

  • (Integer, nil) 


33
 
# File 'lib/telnyx/models/dir/comment_list_params.rb', line 33

optional :page_size, Integer