Class: Telnyx::Models::UserAddressListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/user_address_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

Some parameter documentations has been truncated, see Telnyx::Models::UserAddressListParams::Filter::StreetAddress for more details.

Filter user addresses via street address. Supports partial matching (contains). Matching is not case-sensitive.

Parameters:

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

    If present, user addresses with street_address containing the given




# File 'lib/telnyx/models/user_address_list_params.rb', line 127

Instance Attribute Details

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

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

Returns:



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

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

#page_number ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :page_number, Integer

#page_size ⇒ Integer?

Returns:

  • (Integer, nil) 


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

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>street_address</code>: sorts the result by the
  <code>street_address</code> field in ascending order.
</li>

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

</ul> <br/> If not given, results are sorted by created_at in descending order.

Returns:



45
 
# File 'lib/telnyx/models/user_address_list_params.rb', line 45

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