Class: PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Source, State

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:, phone_number:, source:, state:, updated_at:, reason: nil) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse for more details.

Parameters:




# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 51

Instance Attribute Details

#config_id ⇒ String

The subscription configuration ID.

Returns:

  • (String) 


11
 
# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 11

required :config_id, String

#phone_number ⇒ String

The phone number in E.164 format.

Returns:

  • (String) 


17
 
# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 17

required :phone_number, String

#reason ⇒ String?

Additional context about the state change (e.g., the keyword that was sent).

Returns:

  • (String, nil) 


49
 
# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 49

optional :reason, String

#source ⇒ Symbol, PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source

How the subscription state was changed:

  • ‘MO_KEYWORD` - User sent a keyword (STOP/START)

  • ‘API` - Changed via API

  • ‘CSV_IMPORT` - Imported from CSV

  • ‘CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect

Returns:



28
 
# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 28

required :source, enum: -> { PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source }

#state ⇒ Symbol, PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::State

The subscription state:

  • ‘SUB` - Subscribed (user can receive marketing messages)

  • ‘UNSUB` - Unsubscribed (user has opted out)

Returns:



37
 
# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 37

required :state, enum: -> { PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::State }

#updated_at ⇒ Time

The date and time when the subscription status was last updated.

Returns:

  • (Time) 


43
 
# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 43

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb', line 83