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
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 158 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
210 211 212 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 210 def callback_url @properties['callback_url'] end |
#config_sid ⇒ String
198 199 200 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 198 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
183 184 185 186 187 188 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 183 def context unless @instance_context @instance_context = DomainConfigContext.new(@version , @params['domain_sid']) end @instance_context end |
#continue_on_failure ⇒ Boolean
216 217 218 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 216 def continue_on_failure @properties['continue_on_failure'] end |
#date_created ⇒ Time
222 223 224 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 222 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
228 229 230 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 228 def date_updated @properties['date_updated'] end |
#disable_https ⇒ Boolean
240 241 242 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 240 def disable_https @properties['disable_https'] end |
#domain_sid ⇒ String
192 193 194 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 192 def domain_sid @properties['domain_sid'] end |
#fallback_url ⇒ String
204 205 206 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 204 def fallback_url @properties['fallback_url'] end |
#fetch ⇒ DomainConfigInstance
Fetch the DomainConfigInstance
247 248 249 250 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 247 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
283 284 285 286 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 283 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.DomainConfigInstance #{values}>" end |
#to_s ⇒ Object
Provide a user friendly representation
276 277 278 279 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 276 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
259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 259 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
234 235 236 |
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 234 def url @properties['url'] end |