Class: Telnyx::Models::AuthenticationProviderListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/authentication_provider_list_params.rb

Overview

See Also:

• Resources::AuthenticationProviders#list

Defined Under Namespace

Modules: Sort

Instance Attribute Summary

• #page_number ⇒ Integer^?
• #page_size ⇒ Integer^?
• #sort ⇒ Symbol, ...

  Specifies the sort order for results.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Object constructor

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

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

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

Parameters:

• page_number (Integer) (defaults to: nil)
• page_size (Integer) (defaults to: nil)
• sort (Symbol, Telnyx::Models::AuthenticationProviderListParams::Sort) (defaults to: nil) —

  Specifies the sort order for results. By default sorting direction is ascending.

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

# File 'lib/telnyx/models/authentication_provider_list_params.rb', line 38

Instance Attribute Details

#page_number ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/authentication_provider_list_params.rb', line 13

optional :page_number, Integer

#page_size ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/authentication_provider_list_params.rb', line 18

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/>If not given, results are sorted by created_at in descending order.

Returns:

• (Symbol, Telnyx::Models::AuthenticationProviderListParams::Sort, nil)

# File 'lib/telnyx/models/authentication_provider_list_params.rb', line 36

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