Class: Zavudev::Models::Number10dlc::CampaignCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/number_10dlc/campaign_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(affiliate_marketing:, age_gated:, brand_id:, description:, direct_lending:, embedded_link:, embedded_phone:, name:, number_pooling:, sample_messages:, subscriber_help:, subscriber_opt_in:, subscriber_opt_out:, use_case:, help_message: nil, message_flow: nil, opt_in_keywords: nil, opt_out_keywords: nil, sub_use_cases: nil, request_options: {}) ⇒ Object

Parameters:

  • affiliate_marketing (Boolean)
  • age_gated (Boolean)
  • brand_id (String) —

    ID of the brand to create this campaign under.

  • description (String)
  • direct_lending (Boolean)
  • embedded_link (Boolean)
  • embedded_phone (Boolean)
  • name (String)
  • number_pooling (Boolean)
  • sample_messages (Array<String>)
  • subscriber_help (Boolean)
  • subscriber_opt_in (Boolean)
  • subscriber_opt_out (Boolean)
  • use_case (String) —

    Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).

  • help_message (String) (defaults to: nil)
  • message_flow (String) (defaults to: nil)
  • opt_in_keywords (Array<String>) (defaults to: nil)
  • opt_out_keywords (Array<String>) (defaults to: nil)
  • sub_use_cases (Array<String>) (defaults to: nil)
  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 108

Instance Attribute Details

#affiliate_marketing ⇒ Boolean

Returns:

  • (Boolean) 


14
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 14

required :affiliate_marketing, Zavudev::Internal::Type::Boolean, api_name: :affiliateMarketing

#age_gated ⇒ Boolean

Returns:

  • (Boolean) 


19
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 19

required :age_gated, Zavudev::Internal::Type::Boolean, api_name: :ageGated

#brand_id ⇒ String

ID of the brand to create this campaign under.

Returns:

  • (String) 


25
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 25

required :brand_id, String, api_name: :brandId

#description ⇒ String

Returns:

  • (String) 


30
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 30

required :description, String

#direct_lending ⇒ Boolean

Returns:

  • (Boolean) 


35
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 35

required :direct_lending, Zavudev::Internal::Type::Boolean, api_name: :directLending

#embedded_link ⇒ Boolean

Returns:

  • (Boolean) 


40
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 40

required :embedded_link, Zavudev::Internal::Type::Boolean, api_name: :embeddedLink

#embedded_phone ⇒ Boolean

Returns:

  • (Boolean) 


45
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 45

required :embedded_phone, Zavudev::Internal::Type::Boolean, api_name: :embeddedPhone

#help_message ⇒ String?

Returns:

  • (String, nil) 


86
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 86

optional :help_message, String, api_name: :helpMessage

#message_flow ⇒ String?

Returns:

  • (String, nil) 


91
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 91

optional :message_flow, String, api_name: :messageFlow

#name ⇒ String

Returns:

  • (String) 


50
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 50

required :name, String

#number_pooling ⇒ Boolean

Returns:

  • (Boolean) 


55
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 55

required :number_pooling, Zavudev::Internal::Type::Boolean, api_name: :numberPooling

#opt_in_keywords ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


96
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 96

optional :opt_in_keywords, Zavudev::Internal::Type::ArrayOf[String], api_name: :optInKeywords

#opt_out_keywords ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


101
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 101

optional :opt_out_keywords, Zavudev::Internal::Type::ArrayOf[String], api_name: :optOutKeywords

#sample_messages ⇒ Array<String>

Returns:

  • (Array<String>) 


60
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 60

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

#sub_use_cases ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


106
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 106

optional :sub_use_cases, Zavudev::Internal::Type::ArrayOf[String], api_name: :subUseCases

#subscriber_help ⇒ Boolean

Returns:

  • (Boolean) 


65
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 65

required :subscriber_help, Zavudev::Internal::Type::Boolean, api_name: :subscriberHelp

#subscriber_opt_in ⇒ Boolean

Returns:

  • (Boolean) 


70
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 70

required :subscriber_opt_in, Zavudev::Internal::Type::Boolean, api_name: :subscriberOptIn

#subscriber_opt_out ⇒ Boolean

Returns:

  • (Boolean) 


75
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 75

required :subscriber_opt_out, Zavudev::Internal::Type::Boolean, api_name: :subscriberOptOut

#use_case ⇒ String

Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).

Returns:

  • (String) 


81
 
# File 'lib/zavudev/models/number_10dlc/campaign_create_params.rb', line 81

required :use_case, String, api_name: :useCase