Class: Twilio::REST::Messaging::V1::DomainConfigMessagingServiceInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, messaging_service_sid: nil) ⇒ DomainConfigMessagingServiceInstance

Initialize the DomainConfigMessagingServiceInstance

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 DomainConfigMessagingService resource.

  • sid (String) —

    The SID of the Call resource to fetch.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb', line 128

def initialize(version, payload , messaging_service_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'domain_sid' => payload['domain_sid'],
        'config_sid' => payload['config_sid'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'fallback_url' => payload['fallback_url'],
        'callback_url' => payload['callback_url'],
        'continue_on_failure' => payload['continue_on_failure'],
        '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 = { 'messaging_service_sid' => messaging_service_sid  || @properties['messaging_service_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.



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

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



168
169
170
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb', line 168

def config_sid
    @properties['config_sid']
end

#context ⇒ DomainConfigMessagingServiceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb', line 153

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

#continue_on_failure ⇒ Boolean

Returns Boolean field to set customer delivery preference when there is a failure in linkShortening service.

Returns:

  • (Boolean) —

    Boolean field to set customer delivery preference when there is a failure in linkShortening service



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

def continue_on_failure
    @properties['continue_on_failure']
end

#date_created ⇒ Time

Returns Date this Domain Config was created.

Returns:

  • (Time) —

    Date this Domain Config was created.



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

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.



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

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.



162
163
164
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb', line 162

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.



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

def fallback_url
    @properties['fallback_url']
end

#fetch ⇒ DomainConfigMessagingServiceInstance

Fetch the DomainConfigMessagingServiceInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb', line 231

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

#messaging_service_sid ⇒ String

Returns The unique string that identifies the messaging service.

Returns:

  • (String) —

    The unique string that identifies the messaging service



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end