Class: Twilio::REST::Messaging::V1::DomainConfigInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Messaging::V1::DomainConfigInstance
- Defined in:
- lib/twilio-ruby/rest/messaging/v1/domain_config.rb
Instance Method Summary collapse
-
#callback_url ⇒ String
URL to receive click events to your webhook whenever the recipients click on the shortened links.
-
#config_sid ⇒ String
The unique string that we created to identify the Domain config (prefix ZK).
-
#context ⇒ DomainConfigContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#continue_on_failure ⇒ Boolean
Boolean field to set customer delivery preference when there is a failure in linkShortening service.
-
#date_created ⇒ Time
Date this Domain Config was created.
-
#date_updated ⇒ Time
Date that this Domain Config was last updated.
-
#disable_https ⇒ Boolean
Customer’s choice to send links with/without "https://" attached to shortened url.
-
#domain_sid ⇒ String
The unique string that we created to identify the Domain resource.
-
#fallback_url ⇒ String
Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url.
-
#fetch ⇒ DomainConfigInstance
Fetch the DomainConfigInstance.
-
#initialize(version, payload, domain_sid: nil) ⇒ DomainConfigInstance
constructor
Initialize the DomainConfigInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(fallback_url: :unset, callback_url: :unset, continue_on_failure: :unset, disable_https: :unset) ⇒ DomainConfigInstance
Update the DomainConfigInstance.
- #url ⇒ String
Constructor Details
#initialize(version, payload, domain_sid: nil) ⇒ DomainConfigInstance
Initialize the DomainConfigInstance
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 155 def initialize(version, payload , domain_sid: nil) super(version) # Marshaled Properties @properties = { 'domain_sid' => payload['domain_sid'], 'config_sid' => payload['config_sid'], 'fallback_url' => payload['fallback_url'], 'callback_url' => payload['callback_url'], 'continue_on_failure' => payload['continue_on_failure'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'url' => payload['url'], 'disable_https' => payload['disable_https'], } # Context @instance_context = nil @params = { 'domain_sid' => domain_sid || @properties['domain_sid'] , } end |
Instance Method Details
#callback_url ⇒ String
Returns URL to receive click events to your webhook whenever the recipients click on the shortened links.
207 208 209 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 207 def callback_url @properties['callback_url'] end |
#config_sid ⇒ String
Returns The unique string that we created to identify the Domain config (prefix ZK).
195 196 197 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 195 def config_sid @properties['config_sid'] end |
#context ⇒ DomainConfigContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
180 181 182 183 184 185 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 180 def context unless @instance_context @instance_context = DomainConfigContext.new(@version , @params['domain_sid']) end @instance_context end |
#continue_on_failure ⇒ Boolean
Returns Boolean field to set customer delivery preference when there is a failure in linkShortening service.
213 214 215 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 213 def continue_on_failure @properties['continue_on_failure'] end |
#date_created ⇒ Time
Returns Date this Domain Config was created.
219 220 221 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 219 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns Date that this Domain Config was last updated.
225 226 227 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 225 def date_updated @properties['date_updated'] end |
#disable_https ⇒ Boolean
Returns Customer’s choice to send links with/without "https://" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
237 238 239 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 237 def disable_https @properties['disable_https'] end |
#domain_sid ⇒ String
Returns The unique string that we created to identify the Domain resource.
189 190 191 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 189 def domain_sid @properties['domain_sid'] end |
#fallback_url ⇒ String
Returns Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
201 202 203 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 201 def fallback_url @properties['fallback_url'] end |
#fetch ⇒ DomainConfigInstance
Fetch the DomainConfigInstance
244 245 246 247 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 244 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
280 281 282 283 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 280 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.DomainConfigInstance #{values}>" end |
#to_s ⇒ Object
Provide a user friendly representation
273 274 275 276 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 273 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.DomainConfigInstance #{values}>" end |
#update(fallback_url: :unset, callback_url: :unset, continue_on_failure: :unset, disable_https: :unset) ⇒ DomainConfigInstance
Update the DomainConfigInstance
256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 256 def update( fallback_url: :unset, callback_url: :unset, continue_on_failure: :unset, disable_https: :unset ) context.update( fallback_url: fallback_url, callback_url: callback_url, continue_on_failure: continue_on_failure, disable_https: disable_https, ) end |
#url ⇒ String
231 232 233 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 231 def url @properties['url'] end |