Class: Telnyx::Models::OutboundVoiceProfileListParams

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

Overview

See Also:

Defined Under Namespace

Modules: Sort Classes: Filter

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

Name filtering operations

Parameters:

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

    Optional filter on outbound voice profile name.




# File 'lib/telnyx/models/outbound_voice_profile_list_params.rb', line 81

Instance Attribute Details

#filter ⇒ Telnyx::Models::OutboundVoiceProfileListParams::Filter?

Consolidated filter parameter (deepObject style). Originally: filter[contains]

Returns:



15
 
# File 'lib/telnyx/models/outbound_voice_profile_list_params.rb', line 15

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

#page_number ⇒ Integer?

Returns:

  • (Integer, nil) 


20
 
# File 'lib/telnyx/models/outbound_voice_profile_list_params.rb', line 20

optional :page_number, Integer

#page_size ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#sort ⇒ Symbol, ...

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.<br/><br/> That is: <ul>

<li>
  <code>name</code>: sorts the result by the
  <code>name</code> field in ascending order.
</li>

<li>
  <code>-name</code>: sorts the result by the
  <code>name</code> field in descending order.
</li>

</ul> <br/>

Returns:



44
 
# File 'lib/telnyx/models/outbound_voice_profile_list_params.rb', line 44

optional :sort, enum: -> { Telnyx::OutboundVoiceProfileListParams::Sort }