Class: Twilio::REST::Trusthub::V1::A2PCampaignRegistrationList::TrusthubV1A2pCampaignRegistrationRequest
- Inherits:
-
Object
- Object
- Twilio::REST::Trusthub::V1::A2PCampaignRegistrationList::TrusthubV1A2pCampaignRegistrationRequest
- Defined in:
- lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb
Instance Attribute Summary collapse
- #a2p_brand_registration_sid ⇒ Object
- #age_gated ⇒ Object
- #direct_lending ⇒ Object
- #embedded_url_sample ⇒ Object
- #has_embedded_links ⇒ Object
- #has_embedded_phone ⇒ Object
- #help_keywords ⇒ Object
- #help_message_sample ⇒ Object
- #messaging_service_sid ⇒ Object
- #opt_in_keywords ⇒ Object
- #opt_in_message_sample ⇒ Object
- #opt_out_keywords ⇒ Object
- #opt_out_message_sample ⇒ Object
- #privacy_policy_url ⇒ Object
- #terms_and_conditions_url ⇒ Object
- #theme_set_id ⇒ Object
- #use_case_categories ⇒ Object
- #use_case_description ⇒ Object
- #use_case_opt_in_description ⇒ Object
- #use_case_opt_in_types ⇒ Object
- #use_case_sample_message1 ⇒ Object
- #use_case_sample_message2 ⇒ Object
- #use_case_sample_message3 ⇒ Object
- #use_case_sample_message4 ⇒ Object
- #use_case_sample_message5 ⇒ Object
Instance Method Summary collapse
-
#initialize(payload) ⇒ TrusthubV1A2pCampaignRegistrationRequest
constructor
A new instance of TrusthubV1A2pCampaignRegistrationRequest.
- #to_json(options = {}) ⇒ Object
Constructor Details
#initialize(payload) ⇒ TrusthubV1A2pCampaignRegistrationRequest
Returns a new instance of TrusthubV1A2pCampaignRegistrationRequest.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 49 def initialize(payload) @a2p_brand_registration_sid = payload["a2p_brand_registration_sid"] @messaging_service_sid = payload["messaging_service_sid"] @theme_set_id = payload["theme_set_id"] @use_case_categories = payload["use_case_categories"] @use_case_description = payload["use_case_description"] @use_case_sample_message1 = payload["use_case_sample_message1"] @use_case_sample_message2 = payload["use_case_sample_message2"] @use_case_sample_message3 = payload["use_case_sample_message3"] @use_case_sample_message4 = payload["use_case_sample_message4"] @use_case_sample_message5 = payload["use_case_sample_message5"] @use_case_opt_in_types = payload["use_case_opt_in_types"] @use_case_opt_in_description = payload["use_case_opt_in_description"] @has_embedded_links = payload["has_embedded_links"] @has_embedded_phone = payload["has_embedded_phone"] @embedded_url_sample = payload["embedded_url_sample"] @direct_lending = payload["direct_lending"] @age_gated = payload["age_gated"] @privacy_policy_url = payload["privacy_policy_url"] @terms_and_conditions_url = payload["terms_and_conditions_url"] @opt_in_keywords = payload["opt_in_keywords"] @opt_in_message_sample = payload["opt_in_message_sample"] @opt_out_keywords = payload["opt_out_keywords"] @opt_out_message_sample = payload["opt_out_message_sample"] @help_keywords = payload["help_keywords"] @help_message_sample = payload["help_message_sample"] end |
Instance Attribute Details
#a2p_brand_registration_sid ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def a2p_brand_registration_sid @a2p_brand_registration_sid end |
#age_gated ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def age_gated @age_gated end |
#direct_lending ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def direct_lending @direct_lending end |
#embedded_url_sample ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def embedded_url_sample @embedded_url_sample end |
#has_embedded_links ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def has_embedded_links @has_embedded_links end |
#has_embedded_phone ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def has_embedded_phone @has_embedded_phone end |
#help_keywords ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def help_keywords @help_keywords end |
#help_message_sample ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def help_message_sample @help_message_sample end |
#messaging_service_sid ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def messaging_service_sid @messaging_service_sid end |
#opt_in_keywords ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def opt_in_keywords @opt_in_keywords end |
#opt_in_message_sample ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def opt_in_message_sample @opt_in_message_sample end |
#opt_out_keywords ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def opt_out_keywords @opt_out_keywords end |
#opt_out_message_sample ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def opt_out_message_sample @opt_out_message_sample end |
#privacy_policy_url ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def privacy_policy_url @privacy_policy_url end |
#terms_and_conditions_url ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def terms_and_conditions_url @terms_and_conditions_url end |
#theme_set_id ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def theme_set_id @theme_set_id end |
#use_case_categories ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_categories @use_case_categories end |
#use_case_description ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_description @use_case_description end |
#use_case_opt_in_description ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_opt_in_description @use_case_opt_in_description end |
#use_case_opt_in_types ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_opt_in_types @use_case_opt_in_types end |
#use_case_sample_message1 ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_sample_message1 @use_case_sample_message1 end |
#use_case_sample_message2 ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_sample_message2 @use_case_sample_message2 end |
#use_case_sample_message3 ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_sample_message3 @use_case_sample_message3 end |
#use_case_sample_message4 ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_sample_message4 @use_case_sample_message4 end |
#use_case_sample_message5 ⇒ Object
Parameters:
-
:
(a2p_brand_registration_sid)
—
[String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the
idreturned by the Initialize Brand endpoint (which is formatted astri1.us1.account.AC.../registration.BU...). Retrieve the BN brand SID via GET /v1/a2p/BrandRegistrations/Sid onmessaging.twilio.com. -
:
(messaging_service_sid)
—
[String] The SID of the Messaging Service.
-
:
(theme_set_id)
—
[String] Theme ID for styling the inquiry form.
-
:
(use_case_categories)
—
[Array
] The categories of the messaging use case. -
:
(use_case_description)
—
[String] A description of the messaging use case.
-
:
(use_case_sample_message1)
—
[String] A sample message for the use case.
-
:
(use_case_sample_message2)
—
[String] A second sample message for the use case.
-
:
(use_case_sample_message3)
—
[String] A third sample message for the use case.
-
:
(use_case_sample_message4)
—
[String] A fourth sample message for the use case.
-
:
(use_case_sample_message5)
—
[String] A fifth sample message for the use case.
-
:
(use_case_opt_in_types)
—
[Array
] The opt-in methods for the use case. -
:
(use_case_opt_in_description)
—
[String] A description of the opt-in process.
-
:
(has_embedded_links)
—
[Boolean] Whether messages will contain embedded links.
-
:
(has_embedded_phone)
—
[Boolean] Whether messages will contain embedded phone numbers.
-
:
(embedded_url_sample)
—
[String] A sample URL that will be embedded in messages (must use https://).
-
:
(direct_lending)
—
[Boolean] Whether the campaign involves direct lending.
-
:
(age_gated)
—
[Boolean] Whether the content is age-gated.
-
:
(privacy_policy_url)
—
[String] The URL to the privacy policy.
-
:
(terms_and_conditions_url)
—
[String] The URL to the terms and conditions.
-
:
(opt_in_keywords)
—
[Array
] Keywords users can text to opt in. -
:
(opt_in_message_sample)
—
[String] A sample opt-in confirmation message.
-
:
(opt_out_keywords)
—
[Array
] Keywords users can text to opt out. -
:
(opt_out_message_sample)
—
[String] A sample opt-out confirmation message.
-
:
(help_keywords)
—
[Array
] Keywords users can text for help. -
:
(help_message_sample)
—
[String] A sample help message.
48 49 50 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 48 def use_case_sample_message5 @use_case_sample_message5 end |
Instance Method Details
#to_json(options = {}) ⇒ Object
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_registration.rb', line 76 def to_json(options = {}) { "a2pBrandRegistrationSid": @a2p_brand_registration_sid, "messagingServiceSid": @messaging_service_sid, "themeSetId": @theme_set_id, "useCaseCategories": @use_case_categories, "useCaseDescription": @use_case_description, "useCaseSampleMessage1": @use_case_sample_message1, "useCaseSampleMessage2": @use_case_sample_message2, "useCaseSampleMessage3": @use_case_sample_message3, "useCaseSampleMessage4": @use_case_sample_message4, "useCaseSampleMessage5": @use_case_sample_message5, "useCaseOptInTypes": @use_case_opt_in_types, "useCaseOptInDescription": @use_case_opt_in_description, "hasEmbeddedLinks": @has_embedded_links, "hasEmbeddedPhone": @has_embedded_phone, "embeddedUrlSample": @embedded_url_sample, "directLending": @direct_lending, "ageGated": @age_gated, "privacyPolicyUrl": @privacy_policy_url, "termsAndConditionsUrl": @terms_and_conditions_url, "optInKeywords": @opt_in_keywords, "optInMessageSample": @opt_in_message_sample, "optOutKeywords": @opt_out_keywords, "optOutMessageSample": @opt_out_message_sample, "helpKeywords": @help_keywords, "helpMessageSample": @help_message_sample, }.to_json(options) end |