Class: Telnyx::Models::Whatsapp::TemplateListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Whatsapp::TemplateListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/whatsapp/template_list_params.rb

Overview

See Also:

• Resources::Whatsapp::Templates#list

Defined Under Namespace

Modules: FilterCategory

Instance Attribute Summary

• #filter_category ⇒ Symbol, ...

  Filter by category.

• #filter_search ⇒ String^?

  Search templates by name.

• #filter_status ⇒ String^?

  Filter by template status.

• #filter_waba_id ⇒ String^?

  Filter by WABA ID.

• #page_number ⇒ Integer^?
• #page_size ⇒ Integer^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(filter_category: nil, filter_search: nil, filter_status: nil, filter_waba_id: nil, page_number: nil, page_size: 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_category: nil, filter_search: nil, filter_status: nil, filter_waba_id: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Object

Parameters:

• filter_category (Symbol, Telnyx::Models::Whatsapp::TemplateListParams::FilterCategory) (defaults to: nil) —

  Filter by category

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

  Search templates by name

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

  Filter by template status

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

  Filter by WABA ID

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

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

Instance Attribute Details

#filter_category ⇒ Symbol, ...

Filter by category

Returns:

• (Symbol, Telnyx::Models::Whatsapp::TemplateListParams::FilterCategory, nil)

# File 'lib/telnyx/models/whatsapp/template_list_params.rb', line 15

optional :filter_category, enum: -> { Telnyx::Whatsapp::TemplateListParams::FilterCategory }

#filter_search ⇒ String^?

Search templates by name

Returns:

• (String, nil)

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

optional :filter_search, String

#filter_status ⇒ String^?

Filter by template status

Returns:

• (String, nil)

# File 'lib/telnyx/models/whatsapp/template_list_params.rb', line 27

optional :filter_status, String

#filter_waba_id ⇒ String^?

Filter by WABA ID

Returns:

• (String, nil)

# File 'lib/telnyx/models/whatsapp/template_list_params.rb', line 33

optional :filter_waba_id, String

#page_number ⇒ Integer^?

Returns:

• (Integer, nil)

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

optional :page_number, Integer

#page_size ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/whatsapp/template_list_params.rb', line 43

optional :page_size, Integer