Class: Telnyx::Models::Messaging10dlc::BrandListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Messaging10dlc::BrandListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/messaging_10dlc/brand_list_params.rb,
sig/telnyx/models/messaging_10dlc/brand_list_params.rbs

Overview

See Also:

• Telnyx::Resources::Messaging10dlc::Brand#list

Defined Under Namespace

Modules: Sort

Instance Attribute Summary

• #brand_id ⇒ String^?

  Filter results by the Telnyx Brand id.

• #country ⇒ String^?

  Filter results by country.

• #display_name ⇒ String^?

  Filter results by display name.

• #entity_type ⇒ String^?

  Filter results by entity type.

• #page ⇒ Integer^?

  Page number to retrieve (1-based).

• #records_per_page ⇒ Integer^?

  number of records per page.

• #sort ⇒ Symbol, ...

  Specifies the sort order for results.

• #state ⇒ String^?

  Filter results by state.

• #tcr_brand_id ⇒ String^?

  Filter results by the TCR Brand id.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(brand_id: nil, country: nil, display_name: nil, entity_type: nil, page: nil, records_per_page: nil, sort: nil, state: nil, tcr_brand_id: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(brand_id: nil, country: nil, display_name: nil, entity_type: nil, page: nil, records_per_page: nil, sort: nil, state: nil, tcr_brand_id: nil, request_options: {}) ⇒ Object

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

# File 'lib/telnyx/models/messaging_10dlc/brand_list_params.rb', line 66

Instance Attribute Details

#brand_id ⇒ String^?

Filter results by the Telnyx Brand id

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

optional :brand_id, String

#country ⇒ String^?

Filter results by country.

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

optional :country, String

#display_name ⇒ String^?

Filter results by display name.

# File 'lib/telnyx/models/messaging_10dlc/brand_list_params.rb', line 27

optional :display_name, String

#entity_type ⇒ String^?

Filter results by entity type.

# File 'lib/telnyx/models/messaging_10dlc/brand_list_params.rb', line 33

optional :entity_type, String

#page ⇒ Integer^?

Page number to retrieve (1-based).

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

optional :page, Integer

#records_per_page ⇒ Integer^?

number of records per page. maximum of 500

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

optional :records_per_page, Integer

#sort ⇒ Symbol, ...

Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.

# File 'lib/telnyx/models/messaging_10dlc/brand_list_params.rb', line 52

optional :sort, enum: -> { Telnyx::Messaging10dlc::BrandListParams::Sort }

#state ⇒ String^?

Filter results by state.

# File 'lib/telnyx/models/messaging_10dlc/brand_list_params.rb', line 58

optional :state, String

#tcr_brand_id ⇒ String^?

Filter results by the TCR Brand id

# File 'lib/telnyx/models/messaging_10dlc/brand_list_params.rb', line 64

optional :tcr_brand_id, String

Instance Method Details

#to_hash ⇒ {

# File 'sig/telnyx/models/messaging_10dlc/brand_list_params.rbs', line 73

def to_hash: -> {