Class: Telnyx::Models::Messaging10dlc::CampaignBuilderSubmitParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/messaging_10dlc/campaign_builder_submit_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(brand_id:, description:, usecase:, age_gated: nil, auto_renewal: nil, direct_lending: nil, embedded_link: nil, embedded_link_sample: nil, embedded_phone: nil, help_keywords: nil, help_message: nil, message_flow: nil, mno_ids: nil, number_pool: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reference_id: nil, reseller_id: nil, sample1: nil, sample2: nil, sample3: nil, sample4: nil, sample5: nil, subscriber_help: nil, subscriber_optin: nil, subscriber_optout: nil, sub_usecases: nil, tag: nil, terms_and_conditions: nil, terms_and_conditions_link: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Messaging10dlc::CampaignBuilderSubmitParams for more details.

Parameters:

  • brand_id (String) —

    Alphanumeric identifier of the brand associated with this campaign.

  • description (String) —

    Summary description of this campaign.

  • usecase (String) —

    Campaign usecase. Must be of defined valid types. Use ‘/10dlc/enum/usecase` oper

  • age_gated (Boolean) (defaults to: nil) —

    Age gated message content in campaign.

  • auto_renewal (Boolean) (defaults to: nil) —

    Campaign subscription auto-renewal option. If set to true, then campaign will au

  • direct_lending (Boolean) (defaults to: nil) —

    Direct lending or loan arrangement

  • embedded_link (Boolean) (defaults to: nil) —

    Does message generated by the campaign include URL link in SMS?

  • embedded_link_sample (String) (defaults to: nil) —

    Sample of an embedded link that will be sent to subscribers.

  • embedded_phone (Boolean) (defaults to: nil) —

    Does message generated by the campaign include phone number in SMS?

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

    Subscriber help keywords. Multiple keywords are comma separated without space.

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

    Help message of the campaign.

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

    Message flow description.

  • mno_ids (Array<Integer>) (defaults to: nil) —

    Submit campaign to given list of MNOs by MNO’s network ID. Default is all MNOs i

  • number_pool (Boolean) (defaults to: nil) —

    Does campaign utilize pool of phone numbers?

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

    Subscriber opt-in keywords. Multiple keywords are comma separated without space.

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

    Subscriber opt-in message.

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

    Subscriber opt-out keywords. Multiple keywords are comma separated without space

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

    Subscriber opt-out message.

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

    Link to the campaign’s privacy policy.

  • reference_id (String) (defaults to: nil) —

    Caller supplied campaign reference ID. If supplied, the value must be unique acr

  • reseller_id (String) (defaults to: nil) —

    Alphanumeric identifier of the reseller that you want to associate with this cam

  • sample1 (String) (defaults to: nil) —

    Message sample. Some campaign tiers require 1 or more message samples.

  • sample2 (String) (defaults to: nil) —

    Message sample. Some campaign tiers require 2 or more message samples.

  • sample3 (String) (defaults to: nil) —

    Message sample. Some campaign tiers require 3 or more message samples.

  • sample4 (String) (defaults to: nil) —

    Message sample. Some campaign tiers require 4 or more message samples.

  • sample5 (String) (defaults to: nil) —

    Message sample. Some campaign tiers require 5 or more message samples.

  • subscriber_help (Boolean) (defaults to: nil) —

    Does campaign responds to help keyword(s)?

  • subscriber_optin (Boolean) (defaults to: nil) —

    Does campaign require subscriber to opt-in before SMS is sent to subscriber?

  • subscriber_optout (Boolean) (defaults to: nil) —

    Does campaign support subscriber opt-out keyword(s)?

  • sub_usecases (Array<String>) (defaults to: nil) —

    Campaign sub-usecases. Must be of defined valid sub-usecase types. Use ‘/10dlc/e

  • tag (Array<String>) (defaults to: nil) —

    Tags to be set on the Campaign.

  • terms_and_conditions (Boolean) (defaults to: nil) —

    Is terms and conditions accepted?

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

    Link to the campaign’s terms and conditions.

  • webhook_failover_url (String) (defaults to: nil) —

    Failover webhook to which campaign status updates are sent.

  • webhook_url (String) (defaults to: nil) —

    Webhook to which campaign status updates are sent.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 229

Instance Attribute Details

#age_gated ⇒ Boolean?

Age gated message content in campaign.

Returns:

  • (Boolean, nil) 


34
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 34

optional :age_gated, Telnyx::Internal::Type::Boolean, api_name: :ageGated

#auto_renewal ⇒ Boolean?

Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.

Returns:

  • (Boolean, nil) 


41
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 41

optional :auto_renewal, Telnyx::Internal::Type::Boolean, api_name: :autoRenewal

#brand_id ⇒ String

Alphanumeric identifier of the brand associated with this campaign.

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 15

required :brand_id, String, api_name: :brandId

#description ⇒ String

Summary description of this campaign.

Returns:

  • (String) 


21
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 21

required :description, String

#direct_lending ⇒ Boolean?

Direct lending or loan arrangement

Returns:

  • (Boolean, nil) 


47
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 47

optional :direct_lending, Telnyx::Internal::Type::Boolean, api_name: :directLending

#embedded_link ⇒ Boolean?

Does message generated by the campaign include URL link in SMS?

Returns:

  • (Boolean, nil) 


53
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 53

optional :embedded_link, Telnyx::Internal::Type::Boolean, api_name: :embeddedLink

#embedded_link_sample ⇒ String?

Sample of an embedded link that will be sent to subscribers.

Returns:

  • (String, nil) 


59
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 59

optional :embedded_link_sample, String, api_name: :embeddedLinkSample

#embedded_phone ⇒ Boolean?

Does message generated by the campaign include phone number in SMS?

Returns:

  • (Boolean, nil) 


65
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 65

optional :embedded_phone, Telnyx::Internal::Type::Boolean, api_name: :embeddedPhone

#help_keywords ⇒ String?

Subscriber help keywords. Multiple keywords are comma separated without space.

Returns:

  • (String, nil) 


71
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 71

optional :help_keywords, String, api_name: :helpKeywords

#help_message ⇒ String?

Help message of the campaign.

Returns:

  • (String, nil) 


77
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 77

optional :help_message, String, api_name: :helpMessage

#message_flow ⇒ String?

Message flow description.

Returns:

  • (String, nil) 


83
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 83

optional :message_flow, String, api_name: :messageFlow

#mno_ids ⇒ Array<Integer>?

Submit campaign to given list of MNOs by MNO’s network ID. Default is all MNOs if no value provided.

Returns:

  • (Array<Integer>, nil) 


90
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 90

optional :mno_ids, Telnyx::Internal::Type::ArrayOf[Integer], api_name: :mnoIds

#number_pool ⇒ Boolean?

Does campaign utilize pool of phone numbers?

Returns:

  • (Boolean, nil) 


96
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 96

optional :number_pool, Telnyx::Internal::Type::Boolean, api_name: :numberPool

#optin_keywords ⇒ String?

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

Returns:

  • (String, nil) 


102
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 102

optional :optin_keywords, String, api_name: :optinKeywords

#optin_message ⇒ String?

Subscriber opt-in message.

Returns:

  • (String, nil) 


108
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 108

optional :optin_message, String, api_name: :optinMessage

#optout_keywords ⇒ String?

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

Returns:

  • (String, nil) 


115
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 115

optional :optout_keywords, String, api_name: :optoutKeywords

#optout_message ⇒ String?

Subscriber opt-out message.

Returns:

  • (String, nil) 


121
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 121

optional :optout_message, String, api_name: :optoutMessage

#privacy_policy_link ⇒ String?

Link to the campaign’s privacy policy.

Returns:

  • (String, nil) 


127
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 127

optional :privacy_policy_link, String, api_name: :privacyPolicyLink

#reference_id ⇒ String?

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

Returns:

  • (String, nil) 


135
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 135

optional :reference_id, String, api_name: :referenceId

#reseller_id ⇒ String?

Alphanumeric identifier of the reseller that you want to associate with this campaign.

Returns:

  • (String, nil) 


142
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 142

optional :reseller_id, String, api_name: :resellerId

#sample1 ⇒ String?

Message sample. Some campaign tiers require 1 or more message samples.

Returns:

  • (String, nil) 


148
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 148

optional :sample1, String

#sample2 ⇒ String?

Message sample. Some campaign tiers require 2 or more message samples.

Returns:

  • (String, nil) 


154
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 154

optional :sample2, String

#sample3 ⇒ String?

Message sample. Some campaign tiers require 3 or more message samples.

Returns:

  • (String, nil) 


160
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 160

optional :sample3, String

#sample4 ⇒ String?

Message sample. Some campaign tiers require 4 or more message samples.

Returns:

  • (String, nil) 


166
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 166

optional :sample4, String

#sample5 ⇒ String?

Message sample. Some campaign tiers require 5 or more message samples.

Returns:

  • (String, nil) 


172
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 172

optional :sample5, String

#sub_usecases ⇒ Array<String>?

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use ‘/10dlc/enum/usecase` operation to retrieve list of valid sub-usecases

Returns:

  • (Array<String>, nil) 


197
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 197

optional :sub_usecases, Telnyx::Internal::Type::ArrayOf[String], api_name: :subUsecases

#subscriber_help ⇒ Boolean?

Does campaign responds to help keyword(s)?

Returns:

  • (Boolean, nil) 


178
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 178

optional :subscriber_help, Telnyx::Internal::Type::Boolean, api_name: :subscriberHelp

#subscriber_optin ⇒ Boolean?

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

Returns:

  • (Boolean, nil) 


184
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 184

optional :subscriber_optin, Telnyx::Internal::Type::Boolean, api_name: :subscriberOptin

#subscriber_optout ⇒ Boolean?

Does campaign support subscriber opt-out keyword(s)?

Returns:

  • (Boolean, nil) 


190
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 190

optional :subscriber_optout, Telnyx::Internal::Type::Boolean, api_name: :subscriberOptout

#tag ⇒ Array<String>?

Tags to be set on the Campaign.

Returns:

  • (Array<String>, nil) 


203
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 203

optional :tag, Telnyx::Internal::Type::ArrayOf[String]

#terms_and_conditions ⇒ Boolean?

Is terms and conditions accepted?

Returns:

  • (Boolean, nil) 


209
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 209

optional :terms_and_conditions, Telnyx::Internal::Type::Boolean, api_name: :termsAndConditions

#terms_and_conditions_link ⇒ String?

Link to the campaign’s terms and conditions.

Returns:

  • (String, nil) 


215
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 215

optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink

#usecase ⇒ String

Campaign usecase. Must be of defined valid types. Use ‘/10dlc/enum/usecase` operation to retrieve usecases available for given brand.

Returns:

  • (String) 


28
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 28

required :usecase, String

#webhook_failover_url ⇒ String?

Failover webhook to which campaign status updates are sent.

Returns:

  • (String, nil) 


221
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 221

optional :webhook_failover_url, String, api_name: :webhookFailoverURL

#webhook_url ⇒ String?

Webhook to which campaign status updates are sent.

Returns:

  • (String, nil) 


227
 
# File 'lib/telnyx/models/messaging_10dlc/campaign_builder_submit_params.rb', line 227

optional :webhook_url, String, api_name: :webhookURL