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.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 133

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.



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

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



171
172
173
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 171

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:



156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 156

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.



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

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.



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

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.



165
166
167
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config.rb', line 165

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.



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

def fallback_url
  @properties['fallback_url']
end

#fetch ⇒ DomainConfigInstance

Fetch the DomainConfigInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end