Class: Telnyx::Models::Messaging10dlc::TelnyxDownstreamCampaign

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb

Overview

See Also:

Defined Under Namespace

Modules: CampaignStatus

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(tcr_brand_id:, tcr_campaign_id:, age_gated: nil, assigned_phone_numbers_count: nil, brand_display_name: nil, campaign_status: nil, created_at: nil, description: nil, direct_lending: nil, embedded_link: nil, embedded_link_sample: nil, embedded_phone: nil, failure_reasons: nil, help_keywords: nil, help_message: nil, is_number_pooling_enabled: nil, message_flow: nil, number_pool: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, sample1: nil, sample2: nil, sample3: nil, sample4: nil, sample5: nil, subscriber_optin: nil, subscriber_optout: nil, sub_usecases: nil, terms_and_conditions: nil, terms_and_conditions_link: nil, updated_at: nil, usecase: nil, webhook_failover_url: nil, webhook_url: nil) ⇒ Object

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

Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service.

Parameters:

  • tcr_brand_id (String) —

    Unique identifier assigned to the brand by the registry.

  • tcr_campaign_id (String) —

    Unique identifier assigned to the campaign by the registry.

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

    Age gated content in campaign.

  • assigned_phone_numbers_count (Float) (defaults to: nil) —

    Number of phone numbers associated with the campaign

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

    Display or marketing name of the brand.

  • campaign_status (Symbol, Telnyx::Models::Messaging10dlc::TelnyxDownstreamCampaign::CampaignStatus) (defaults to: nil) —

    Campaign status

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

    Date and time that the brand was created at.

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

    Summary description of this campaign.

  • 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?

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

    Failure reasons if campaign submission failed

  • 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.

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

    Indicates whether the campaign has a T-Mobile number pool ID associated with it.

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

    Message flow description.

  • 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.

  • 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_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

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

    Is terms & conditions accepted?

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

    Link to the campaign’s terms and conditions.

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

    Date and time that the brand was last updated at.

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

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

  • 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.




# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 237

Instance Attribute Details

#age_gated ⇒ Boolean?

Age gated content in campaign.

Returns:

  • (Boolean, nil) 


24
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 24

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

#assigned_phone_numbers_count ⇒ Float?

Number of phone numbers associated with the campaign

Returns:

  • (Float, nil) 


30
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 30

optional :assigned_phone_numbers_count, Float, api_name: :assignedPhoneNumbersCount

#brand_display_name ⇒ String?

Display or marketing name of the brand.

Returns:

  • (String, nil) 


36
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 36

optional :brand_display_name, String, api_name: :brandDisplayName

#campaign_status ⇒ Symbol, ...

Campaign status

Returns:



42
43
44
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 42

optional :campaign_status,
enum: -> { Telnyx::Messaging10dlc::TelnyxDownstreamCampaign::CampaignStatus },
api_name: :campaignStatus

#created_at ⇒ String?

Date and time that the brand was created at.

Returns:

  • (String, nil) 


50
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 50

optional :created_at, String, api_name: :createdAt

#description ⇒ String?

Summary description of this campaign.

Returns:

  • (String, nil) 


56
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 56

optional :description, String

#direct_lending ⇒ Boolean?

Direct lending or loan arrangement.

Returns:

  • (Boolean, nil) 


62
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 62

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) 


68
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 68

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) 


74
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 74

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) 


80
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 80

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

#failure_reasons ⇒ String?

Failure reasons if campaign submission failed

Returns:

  • (String, nil) 


86
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 86

optional :failure_reasons, String, api_name: :failureReasons

#help_keywords ⇒ String?

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

Returns:

  • (String, nil) 


92
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 92

optional :help_keywords, String, api_name: :helpKeywords

#help_message ⇒ String?

Help message of the campaign.

Returns:

  • (String, nil) 


98
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 98

optional :help_message, String, api_name: :helpMessage

#is_number_pooling_enabled ⇒ Boolean?

Indicates whether the campaign has a T-Mobile number pool ID associated with it.

Returns:

  • (Boolean, nil) 


104
105
106
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 104

optional :is_number_pooling_enabled,
Telnyx::Internal::Type::Boolean,
api_name: :isNumberPoolingEnabled

#message_flow ⇒ String?

Message flow description.

Returns:

  • (String, nil) 


112
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 112

optional :message_flow, String, api_name: :messageFlow

#number_pool ⇒ Boolean?

Does campaign utilize pool of phone numbers?

Returns:

  • (Boolean, nil) 


118
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 118

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) 


124
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 124

optional :optin_keywords, String, api_name: :optinKeywords

#optin_message ⇒ String?

Subscriber opt-in message.

Returns:

  • (String, nil) 


130
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 130

optional :optin_message, String, api_name: :optinMessage

#optout_keywords ⇒ String?

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

Returns:

  • (String, nil) 


137
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 137

optional :optout_keywords, String, api_name: :optoutKeywords

#optout_message ⇒ String?

Subscriber opt-out message.

Returns:

  • (String, nil) 


143
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 143

optional :optout_message, String, api_name: :optoutMessage

#privacy_policy_link ⇒ String?

Link to the campaign’s privacy policy.

Returns:

  • (String, nil) 


149
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 149

optional :privacy_policy_link, String, api_name: :privacyPolicyLink

#sample1 ⇒ String?

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

Returns:

  • (String, nil) 


155
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 155

optional :sample1, String

#sample2 ⇒ String?

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

Returns:

  • (String, nil) 


161
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 161

optional :sample2, String

#sample3 ⇒ String?

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

Returns:

  • (String, nil) 


167
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 167

optional :sample3, String

#sample4 ⇒ String?

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

Returns:

  • (String, nil) 


173
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 173

optional :sample4, String

#sample5 ⇒ String?

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

Returns:

  • (String, nil) 


179
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 179

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) 


198
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 198

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

#subscriber_optin ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


185
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 185

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

#subscriber_optout ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


191
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 191

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

#tcr_brand_id ⇒ String

Unique identifier assigned to the brand by the registry.

Returns:

  • (String) 


12
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 12

required :tcr_brand_id, String, api_name: :tcrBrandId

#tcr_campaign_id ⇒ String

Unique identifier assigned to the campaign by the registry.

Returns:

  • (String) 


18
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 18

required :tcr_campaign_id, String, api_name: :tcrCampaignId

#terms_and_conditions ⇒ Boolean?

Is terms & conditions accepted?

Returns:

  • (Boolean, nil) 


204
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 204

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) 


210
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 210

optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink

#updated_at ⇒ String?

Date and time that the brand was last updated at.

Returns:

  • (String, nil) 


216
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 216

optional :updated_at, String, api_name: :updatedAt

#usecase ⇒ String?

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

Returns:

  • (String, nil) 


223
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 223

optional :usecase, String

#webhook_failover_url ⇒ String?

Failover webhook to which campaign status updates are sent.

Returns:

  • (String, nil) 


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

optional :webhook_failover_url, String, api_name: :webhookFailoverURL

#webhook_url ⇒ String?

Webhook to which campaign status updates are sent.

Returns:

  • (String, nil) 


235
 
# File 'lib/telnyx/models/messaging_10dlc/telnyx_downstream_campaign.rb', line 235

optional :webhook_url, String, api_name: :webhookURL