Class: Twilio::REST::Messaging::V1::DomainConfigContext

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, domain_sid) ⇒ DomainConfigContext

Initialize the DomainConfigContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • domain_sid (String) —

    Unique string used to identify the domain that this config should be associated with.



50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 50

def initialize(version, domain_sid)
    super(version)

    # Path Solution
    @solution = { domain_sid: domain_sid,  }
    @uri = "/LinkShortening/Domains/#{@solution[:domain_sid]}/Config"

    
end

Instance Method Details

#fetch ⇒ DomainConfigInstance

Fetch the DomainConfigInstance

Returns:



62
63
64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 62

def fetch

    payload = @version.fetch('GET', @uri)
    DomainConfigInstance.new(
        @version,
        payload,
        domain_sid: @solution[:domain_sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



105
106
107
108
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 105

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Messaging.V1.DomainConfigContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



98
99
100
101
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 98

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Messaging.V1.DomainConfigContext #{context}>"
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:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 77

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

    data = Twilio::Values.of({
        'FallbackUrl' => fallback_url,
        'CallbackUrl' => callback_url,
    })

    payload = @version.update('POST', @uri, data: data)
    DomainConfigInstance.new(
        @version,
        payload,
        domain_sid: @solution[:domain_sid],
    )
end