Class: Sentdm::Models::Profiles::CampaignData

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/profiles/campaign_data.rb,
sig/sentdm/models/profiles/campaign_data.rbs

Instance Attribute 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(description:, name:, type:, use_cases:, help_keywords: nil, help_message: nil, message_flow: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil, volume: nil) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::Profiles::CampaignData for more details.

Campaign data for create or update operation

Parameters:

  • description (String) —

    Campaign description

  • name (String) —

    Campaign name

  • type (String) —

    Campaign type (e.g., "KYC", "App")

  • use_cases (Array<Sentdm::Models::Profiles::CampaignUseCaseData>) —

    List of use cases with sample messages

  • help_keywords (String, nil) (defaults to: nil) —

    Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")

  • help_message (String, nil) (defaults to: nil) —

    Message sent when user requests help

  • message_flow (String, nil) (defaults to: nil) —

    Description of how messages flow in the campaign

  • optin_keywords (String, nil) (defaults to: nil) —

    Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")

  • optin_message (String, nil) (defaults to: nil) —

    Message sent when user opts in

  • optout_keywords (String, nil) (defaults to: nil) —

    Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")

  • optout_message (String, nil) (defaults to: nil) —

    Message sent when user opts out

  • privacy_policy_link (String, nil) (defaults to: nil) —

    URL to privacy policy

  • terms_and_conditions_link (String, nil) (defaults to: nil) —

    URL to terms and conditions

  • volume (String, nil) (defaults to: nil) —

    Expected messaging volume for this campaign. Numeric string (e.g. "1999", "5000"




# File 'lib/sentdm/models/profiles/campaign_data.rb', line 94

Instance Attribute Details

#description ⇒ String

Campaign description

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 11

required :description, String

#help_keywords ⇒ String?

Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


37
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 37

optional :help_keywords, String, api_name: :helpKeywords, nil?: true

#help_message ⇒ String?

Message sent when user requests help

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


43
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 43

optional :help_message, String, api_name: :helpMessage, nil?: true

#message_flow ⇒ String?

Description of how messages flow in the campaign

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


49
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 49

optional :message_flow, String, api_name: :messageFlow, nil?: true

#name ⇒ String

Campaign name

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 17

required :name, String

#optin_keywords ⇒ String?

Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


55
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 55

optional :optin_keywords, String, api_name: :optinKeywords, nil?: true

#optin_message ⇒ String?

Message sent when user opts in

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 61

optional :optin_message, String, api_name: :optinMessage, nil?: true

#optout_keywords ⇒ String?

Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


67
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 67

optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true

#optout_message ⇒ String?

Message sent when user opts out

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


73
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 73

optional :optout_message, String, api_name: :optoutMessage, nil?: true

#privacy_policy_link ⇒ String?

URL to privacy policy

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


79
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 79

optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true

#terms_and_conditions_link ⇒ String?

URL to terms and conditions

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


85
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 85

optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true

#type ⇒ String

Campaign type (e.g., "KYC", "App")

Parameters:

  • value (String)

Returns:

  • (String) 


23
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 23

required :type, String

#use_cases ⇒ Array<Sentdm::Models::Profiles::CampaignUseCaseData>

List of use cases with sample messages

Parameters:

  • value (::Array[Sentdm::Profiles::CampaignUseCaseData])

Returns:



29
30
31
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 29

required :use_cases,
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignUseCaseData] },
api_name: :useCases

#volume ⇒ String?

Expected messaging volume for this campaign. Numeric string (e.g. "1999", "5000"); values below 2000 bill at the low-volume tier.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


92
 
# File 'lib/sentdm/models/profiles/campaign_data.rb', line 92

optional :volume, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/sentdm/models/profiles/campaign_data.rbs', line 68

def to_hash: -> {