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

Overview

See Also:

• Resources::Messaging10dlc::Brand#list

Defined Under Namespace

Modules: Sort

Instance Attribute Summary

• #brand_id ⇒ String^?

  Filter results by the Telnyx Brand id.

• #country ⇒ String^?
• #display_name ⇒ String^?
• #entity_type ⇒ String^?
• #page ⇒ Integer^?
• #records_per_page ⇒ Integer^?

  number of records per page.

• #sort ⇒ Symbol, ...

  Specifies the sort order for results.

• #state ⇒ String^?
• #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.

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.

Parameters:

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

  Filter results by the Telnyx Brand id

• country (String) (defaults to: nil)
• display_name (String) (defaults to: nil)
• entity_type (String) (defaults to: nil)
• page (Integer) (defaults to: nil)
• records_per_page (Integer) (defaults to: nil) —

  number of records per page. maximum of 500

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

  Specifies the sort order for results. If not given, results are sorted by create

• state (String) (defaults to: nil)
• tcr_brand_id (String) (defaults to: nil) —

  Filter results by the TCR Brand id

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

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

Instance Attribute Details

#brand_id ⇒ String^?

Filter results by the Telnyx Brand id

Returns:

• (String, nil)

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

optional :brand_id, String

#country ⇒ String^?

Returns:

• (String, nil)

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

optional :country, String

#display_name ⇒ String^?

Returns:

• (String, nil)

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

optional :display_name, String

#entity_type ⇒ String^?

Returns:

• (String, nil)

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

optional :entity_type, String

#page ⇒ Integer^?

Returns:

• (Integer, nil)

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

optional :page, Integer

#records_per_page ⇒ Integer^?

number of records per page. maximum of 500

Returns:

• (Integer, nil)

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

optional :records_per_page, Integer

#sort ⇒ Symbol, ...

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

Returns:

• (Symbol, Telnyx::Models::Messaging10dlc::BrandListParams::Sort, nil)

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

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

#state ⇒ String^?

Returns:

• (String, nil)

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

optional :state, String

#tcr_brand_id ⇒ String^?

Filter results by the TCR Brand id

Returns:

• (String, nil)

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

optional :tcr_brand_id, String