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

Inherits:
InstanceResource 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, payload, domain_sid: nil) ⇒ DomainConfigInstance

Initialize the DomainConfigInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • domain_sid (String) (defaults to: nil) —

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 142

def initialize(version, payload, domain_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'domain_sid' => payload['domain_sid'],
      'config_sid' => payload['config_sid'],
      'messaging_service_sids' => payload['messaging_service_sids'],
      '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).



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

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:



166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 166

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.



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

def domain_sid
  @properties['domain_sid']
end

#fallback_url ⇒ String

Returns We will redirect requests to urls we are unable to identify to this url.

Returns:

  • (String) —

    We will redirect requests to urls we are unable to identify to this url.



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:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



259
260
261
262
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 259

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

#messaging_service_sids ⇒ Array[String]

Returns A list of messagingServiceSids (with prefix MG).

Returns:

  • (Array[String]) —

    A list of messagingServiceSids (with prefix MG).



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

def messaging_service_sids
  @properties['messaging_service_sids']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def update(messaging_service_sids: nil, fallback_url: :unset, callback_url: :unset, messaging_service_sids_action: :unset)
  context.update(
      messaging_service_sids: messaging_service_sids,
      fallback_url: fallback_url,
      callback_url: callback_url,
      messaging_service_sids_action: messaging_service_sids_action,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end