Class: Telnyx::Models::VoiceCloneListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/voice_clone_list_params.rb

Overview

See Also:

• Resources::VoiceClones#list

Defined Under Namespace

Modules: FilterProvider, Sort

Instance Attribute Summary

• #filter_name ⇒ String^?

  Case-insensitive substring filter on the name field.

• #filter_provider ⇒ Symbol, ...

  Filter by voice synthesis provider.

• #page_number ⇒ Integer^?

  Page number for pagination (1-based).

• #page_size ⇒ Integer^?

  Number of results per page.

• #sort ⇒ Symbol, ...

  Sort order.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

Parameters:

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

  Case-insensitive substring filter on the name field.

• filter_provider (Symbol, Telnyx::Models::VoiceCloneListParams::FilterProvider) (defaults to: nil) —

  Filter by voice synthesis provider. Case-insensitive.

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

  Page number for pagination (1-based).

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

  Number of results per page.

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

  Sort order. Prefix with ‘-` for descending. Defaults to `-created_at`.

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

# File 'lib/telnyx/models/voice_clone_list_params.rb', line 40

Instance Attribute Details

#filter_name ⇒ String^?

Case-insensitive substring filter on the name field.

Returns:

• (String, nil)

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

optional :filter_name, String

#filter_provider ⇒ Symbol, ...

Filter by voice synthesis provider. Case-insensitive.

Returns:

• (Symbol, Telnyx::Models::VoiceCloneListParams::FilterProvider, nil)

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

optional :filter_provider, enum: -> { Telnyx::VoiceCloneListParams::FilterProvider }

#page_number ⇒ Integer^?

Page number for pagination (1-based).

Returns:

• (Integer, nil)

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

optional :page_number, Integer

#page_size ⇒ Integer^?

Number of results per page.

Returns:

• (Integer, nil)

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

optional :page_size, Integer

#sort ⇒ Symbol, ...

Sort order. Prefix with ‘-` for descending. Defaults to `-created_at`.

Returns:

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

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/voice_clone_list_params.rb', line 60