Class: Telnyx::Models::TrafficPolicyProfileListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/traffic_policy_profile_list_params.rb

Overview

See Also:

• Resources::TrafficPolicyProfiles#list

Defined Under Namespace

Modules: FilterType, Sort

Instance Attribute Summary

• #filter_service ⇒ String^?

  Filter by service ID.

• #filter_type ⇒ Symbol, ...

  Filter by traffic policy profile type.

• #page_number ⇒ Integer^?

  The page number to load.

• #page_size ⇒ Integer^?

  The size of the page.

• #sort ⇒ Symbol, ...

  Sorts traffic policy profiles by the given field.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

  Some parameter documentations has been truncated, see TrafficPolicyProfileListParams 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(filter_service: nil, filter_type: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Filter by service ID.

• filter_type (Symbol, Telnyx::Models::TrafficPolicyProfileListParams::FilterType) (defaults to: nil) —

  Filter by traffic policy profile type.

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

  The page number to load.

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

  The size of the page.

• sort (Symbol, Telnyx::Models::TrafficPolicyProfileListParams::Sort) (defaults to: nil) —

  Sorts traffic policy profiles by the given field. Defaults to ascending order un

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

# File 'lib/telnyx/models/traffic_policy_profile_list_params.rb', line 41

Instance Attribute Details

#filter_service ⇒ String^?

Filter by service ID.

Returns:

• (String, nil)

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

optional :filter_service, String

#filter_type ⇒ Symbol, ...

Filter by traffic policy profile type.

Returns:

• (Symbol, Telnyx::Models::TrafficPolicyProfileListParams::FilterType, nil)

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

optional :filter_type, enum: -> { Telnyx::TrafficPolicyProfileListParams::FilterType }

#page_number ⇒ Integer^?

The page number to load.

Returns:

• (Integer, nil)

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

optional :page_number, Integer

#page_size ⇒ Integer^?

The size of the page.

Returns:

• (Integer, nil)

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

optional :page_size, Integer

#sort ⇒ Symbol, ...

Sorts traffic policy profiles by the given field. Defaults to ascending order unless field is prefixed with a minus sign.

Returns:

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

# File 'lib/telnyx/models/traffic_policy_profile_list_params.rb', line 39

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/traffic_policy_profile_list_params.rb', line 65