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.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 149

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'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # 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.



199
200
201
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 199

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).



187
188
189
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 187

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:



172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 172

def context
    unless @instance_context
        @instance_context = DomainConfigContext.new(@version , @params['domain_sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns Date this Domain Config was created.

Returns:

  • (Time) —

    Date this Domain Config was created.



205
206
207
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 205

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.



211
212
213
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 211

def date_updated
    @properties['date_updated']
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.



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

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.



193
194
195
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 193

def fallback_url
    @properties['fallback_url']
end

#fetch ⇒ DomainConfigInstance

Fetch the DomainConfigInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



254
255
256
257
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 254

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(fallback_url: :unset, callback_url: :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

Returns:



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 234

def update(
    fallback_url: :unset, 
    callback_url: :unset
)

    context.update(
        fallback_url: fallback_url, 
        callback_url: callback_url, 
    )
end

#url ⇒ String

Returns:

  • (String) 


217
218
219
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 217

def url
    @properties['url']
end