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
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 166 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
218 219 220 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 218 def callback_url @properties['callback_url'] end |
#config_sid ⇒ String
206 207 208 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 206 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
191 192 193 194 195 196 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 191 def context unless @instance_context @instance_context = DomainConfigContext.new(@version , @params['domain_sid']) end @instance_context end |
#continue_on_failure ⇒ Boolean
224 225 226 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 224 def continue_on_failure @properties['continue_on_failure'] end |
#date_created ⇒ Time
230 231 232 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 230 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
236 237 238 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 236 def date_updated @properties['date_updated'] end |
#disable_https ⇒ Boolean
248 249 250 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 248 def disable_https @properties['disable_https'] end |
#domain_sid ⇒ String
200 201 202 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 200 def domain_sid @properties['domain_sid'] end |
#fallback_url ⇒ String
212 213 214 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 212 def fallback_url @properties['fallback_url'] end |
#fetch ⇒ DomainConfigInstance
Fetch the DomainConfigInstance
255 256 257 258 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 255 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
291 292 293 294 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 291 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.DomainConfigInstance #{values}>" end |
#to_s ⇒ Object
Provide a user friendly representation
284 285 286 287 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 284 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
267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 267 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
242 243 244 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 242 def url @properties['url'] end |