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

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

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) ⇒ 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::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>) —

    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




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

Instance Attribute Details

#description ⇒ String

Campaign description

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”)

Returns:

  • (String, nil) 


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

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

#help_message ⇒ String?

Message sent when user requests help

Returns:

  • (String, nil) 


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

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

#message_flow ⇒ String?

Description of how messages flow in the campaign

Returns:

  • (String, nil) 


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

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

#name ⇒ String

Campaign name

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”)

Returns:

  • (String, nil) 


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

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

#optin_message ⇒ String?

Message sent when user opts in

Returns:

  • (String, nil) 


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

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

#optout_keywords ⇒ String?

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

Returns:

  • (String, nil) 


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

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

#optout_message ⇒ String?

Message sent when user opts out

Returns:

  • (String, nil) 


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

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

#privacy_policy_link ⇒ String?

URL to privacy policy

Returns:

  • (String, nil) 


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

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

#terms_and_conditions_link ⇒ String?

URL to terms and conditions

Returns:

  • (String, nil) 


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

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

#type ⇒ String

Campaign type (e.g., “KYC”, “App”)

Returns:

  • (String) 


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

required :type, String

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

List of use cases with sample messages

Returns:



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

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