Class: PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb

Overview

See Also:

• Resources::Notify#list_subscription_phone_numbers

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #config_id ⇒ String
• #cursor ⇒ String^?

  Pagination cursor from the previous response.

• #limit ⇒ Integer^?

  Maximum number of phone numbers to return per page.

• #state ⇒ Symbol, ...

  Filter by subscription state.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(config_id:, cursor: nil, limit: nil, state: 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(config_id:, cursor: nil, limit: nil, state: nil, request_options: {}) ⇒ Object

Parameters:

• config_id (String)
• cursor (String) (defaults to: nil) —

  Pagination cursor from the previous response

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

  Maximum number of phone numbers to return per page

• state (Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::State) (defaults to: nil) —

  Filter by subscription state

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

# File 'lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb', line 33

Instance Attribute Details

#config_id ⇒ String

Returns:

• (String)

# File 'lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb', line 13

required :config_id, String

#cursor ⇒ String^?

Pagination cursor from the previous response

Returns:

• (String, nil)

# File 'lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb', line 19

optional :cursor, String

#limit ⇒ Integer^?

Maximum number of phone numbers to return per page

Returns:

• (Integer, nil)

# File 'lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb', line 25

optional :limit, Integer

#state ⇒ Symbol, ...

Filter by subscription state

Returns:

• (Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::State, nil)

# File 'lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb', line 31

optional :state, enum: -> { PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State }