Class: Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase

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

Defined Under Namespace

Modules: MessagingUseCaseUs

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(messaging_use_case_us:, sample_messages:) ⇒ Object

Campaign use case with sample messages

Parameters:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/sentdm/models/profiles/campaign_create_params.rb', line 170

class UseCase < Sentdm::Internal::Type::BaseModel
  # @!attribute messaging_use_case_us
  #
  #   @return [Symbol, Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs]
  required :messaging_use_case_us,
           enum: -> {
             Sentdm::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs
           },
           api_name: :messagingUseCaseUs

  # @!attribute sample_messages
  #   Sample messages for this use case (1-5 messages, max 1024 characters each)
  #
  #   @return [Array<String>]
  required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages

  # @!method initialize(messaging_use_case_us:, sample_messages:)
  #   Campaign use case with sample messages
  #
  #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs]
  #
  #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)

  # @see Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase#messaging_use_case_us
  module MessagingUseCaseUs
    extend Sentdm::Internal::Type::Enum

    MARKETING = :MARKETING
    ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
    CUSTOMER_CARE = :CUSTOMER_CARE
    FRAUD_ALERT = :FRAUD_ALERT
    TWO_FA = :TWO_FA
    DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
    SECURITY_ALERT = :SECURITY_ALERT
    M2_M = :M2M
    MIXED = :MIXED
    HIGHER_EDUCATION = :HIGHER_EDUCATION
    POLLING_VOTING = :POLLING_VOTING
    PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
    LOW_VOLUME = :LOW_VOLUME

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#messaging_use_case_us ⇒ Symbol, Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs

Returns:



174
175
176
177
178
 
# File 'lib/sentdm/models/profiles/campaign_create_params.rb', line 174

required :messaging_use_case_us,
enum: -> {
  Sentdm::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs
},
api_name: :messagingUseCaseUs

#sample_messages ⇒ Array<String>

Sample messages for this use case (1-5 messages, max 1024 characters each)

Returns:

  • (Array<String>) 


184
 
# File 'lib/sentdm/models/profiles/campaign_create_params.rb', line 184

required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages