Class: Twilio::REST::Messaging::V1::DomainConfigInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/domain_config.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, domain_sid: nil) ⇒ DomainConfigInstance

Initialize the DomainConfigInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this DomainConfig resource.

  • sid (String) —

    The SID of the Call resource to fetch.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 156

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.

Returns:

  • (String) —

    URL to receive click events to your webhook whenever the recipients click on the shortened links.



208
209
210
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 208

def callback_url
    @properties['callback_url']
end

#config_sid ⇒ String

Returns The unique string that we created to identify the Domain config (prefix ZK).

Returns:

  • (String) —

    The unique string that we created to identify the Domain config (prefix ZK).



196
197
198
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 196

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

Returns:



181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 181

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.

Returns:

  • (Boolean) —

    Boolean field to set customer delivery preference when there is a failure in linkShortening service



214
215
216
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 214

def continue_on_failure
    @properties['continue_on_failure']
end

#date_created ⇒ Time

Returns Date this Domain Config was created.

Returns:

  • (Time) —

    Date this Domain Config was created.



220
221
222
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 220

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns Date that this Domain Config was last updated.

Returns:

  • (Time) —

    Date that this Domain Config was last updated.



226
227
228
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 226

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.

Returns:

  • (Boolean) —

    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.



238
239
240
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 238

def disable_https
    @properties['disable_https']
end

#domain_sid ⇒ String

Returns The unique string that we created to identify the Domain resource.

Returns:

  • (String) —

    The unique string that we created to identify the Domain resource.



190
191
192
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 190

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.

Returns:

  • (String) —

    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.



202
203
204
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 202

def fallback_url
    @properties['fallback_url']
end

#fetch ⇒ DomainConfigInstance

Fetch the DomainConfigInstance

Returns:



245
246
247
248
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 245

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



281
282
283
284
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 281

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.DomainConfigInstance #{values}>"
end

#to_s ⇒ Object

Provide a user friendly representation



274
275
276
277
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 274

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

Parameters:

  • fallback_url (String) (defaults to: :unset) —

    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.

  • callback_url (String) (defaults to: :unset) —

    URL to receive click events to your webhook whenever the recipients click on the shortened links

  • continue_on_failure (Boolean) (defaults to: :unset) —

    Boolean field to set customer delivery preference when there is a failure in linkShortening service

  • disable_https (Boolean) (defaults to: :unset) —

    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.

Returns:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 257

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

Returns:

  • (String) 


232
233
234
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 232

def url
    @properties['url']
end