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.



74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 74

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:



111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 111

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



126
127
128
129
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 126

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

#to_s ⇒ Object

Provide a user friendly representation



119
120
121
122
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 119

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

#update(messaging_service_sids: nil, fallback_url: :unset, callback_url: :unset, messaging_service_sids_action: :unset) ⇒ DomainConfigInstance

Update the DomainConfigInstance

Parameters:

  • messaging_service_sids (Array[String]) (defaults to: nil) —

    A list of messagingServiceSids (with prefix MG)

  • 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

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

    An action type for messaging_service_sids operation (ADD, DELETE, REPLACE)

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 95

def update(messaging_service_sids: nil, fallback_url: :unset, callback_url: :unset, messaging_service_sids_action: :unset)
  data = Twilio::Values.of({
      'MessagingServiceSids' => Twilio.serialize_list(messaging_service_sids) { |e| e },
      'FallbackUrl' => fallback_url,
      'CallbackUrl' => callback_url,
      'MessagingServiceSidsAction' => messaging_service_sids_action,
  })

  payload = @version.update('POST', @uri, data: data)

  DomainConfigInstance.new(@version, payload, domain_sid: @solution[:domain_sid], )
end