Class: Telnyx::Models::DocumentListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::DocumentListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/document_list_params.rb

Overview

See Also:

• Resources::Documents#list

Defined Under Namespace

Modules: Sort Classes: Filter

Instance Attribute Summary

• #filter ⇒ Telnyx::Models::DocumentListParams::Filter^?

  Consolidated filter parameter for documents (deepObject style).

• #page_number ⇒ Integer^?
• #page_size ⇒ Integer^?
• #sort ⇒ Array<Symbol, Telnyx::Models::DocumentListParams::Sort>^?

  Consolidated sort parameter for documents (deepObject style).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(contains: nil) ⇒ Object constructor

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(contains: nil) ⇒ Object

Parameters:

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

  Filter by string matching part of filename.

# File 'lib/telnyx/models/document_list_params.rb', line 121

Instance Attribute Details

#filter ⇒ Telnyx::Models::DocumentListParams::Filter^?

Consolidated filter parameter for documents (deepObject style). Originally: filter[contains], filter[eq], filter[in][], filter[gt], filter[lt]

Returns:

• (Telnyx::Models::DocumentListParams::Filter, nil)

# File 'lib/telnyx/models/document_list_params.rb', line 16

optional :filter, -> { Telnyx::DocumentListParams::Filter }

#page_number ⇒ Integer^?

Returns:

• (Integer, nil)

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

optional :page_number, Integer

#page_size ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/document_list_params.rb', line 26

optional :page_size, Integer

#sort ⇒ Array<Symbol, Telnyx::Models::DocumentListParams::Sort>^?

Consolidated sort parameter for documents (deepObject style). Originally: sort[]

Returns:

• (Array<Symbol, Telnyx::Models::DocumentListParams::Sort>, nil)

# File 'lib/telnyx/models/document_list_params.rb', line 32

optional :sort, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::DocumentListParams::Sort] }