Class: Telnyx::Models::Messaging10dlc::PhoneNumberCampaignListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rb

Overview

See Also:

• Resources::Messaging10dlc::PhoneNumberCampaigns#list

Defined Under Namespace

Modules: Sort Classes: Filter

Instance Attribute Summary

• #filter ⇒ Telnyx::Models::Messaging10dlc::PhoneNumberCampaignListParams::Filter^?

  Consolidated filter parameter (deepObject style).

• #page ⇒ Integer^?
• #records_per_page ⇒ Integer^?
• #sort ⇒ Symbol, ...

  Specifies the sort order for results.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(tcr_brand_id: nil, tcr_campaign_id: nil, telnyx_brand_id: nil, telnyx_campaign_id: nil) ⇒ Object constructor

  Consolidated filter parameter (deepObject style).

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(tcr_brand_id: nil, tcr_campaign_id: nil, telnyx_brand_id: nil, telnyx_campaign_id: nil) ⇒ Object

Consolidated filter parameter (deepObject style). Originally: filter, filter, filter, filter

Parameters:

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

  Filter results by the TCR Brand id

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

  Filter results by the TCR Campaign id

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

  Filter results by the Telnyx Brand id

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

  Filter results by the Telnyx Campaign id

# File 'lib/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rb', line 76

Instance Attribute Details

#filter ⇒ Telnyx::Models::Messaging10dlc::PhoneNumberCampaignListParams::Filter^?

Consolidated filter parameter (deepObject style). Originally: filter, filter, filter, filter

Returns:

• (Telnyx::Models::Messaging10dlc::PhoneNumberCampaignListParams::Filter, nil)

# File 'lib/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rb', line 17

optional :filter, -> { Telnyx::Messaging10dlc::PhoneNumberCampaignListParams::Filter }

#page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rb', line 22

optional :page, Integer

#records_per_page ⇒ Integer^?

Returns:

• (Integer, nil)

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

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::PhoneNumberCampaignListParams::Sort, nil)

# File 'lib/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rb', line 34

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