Class: Twilio::REST::Verify::V2::ServiceContext::MessagingConfigurationInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, country: nil) ⇒ MessagingConfigurationInstance

Initialize the MessagingConfigurationInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 265

def initialize(version, payload , service_sid: nil, country: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'country' => payload['country'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        '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 = { 'service_sid' => service_sid  || @properties['service_sid']  ,'country' => country  || @properties['country']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Service resource.

Returns:



297
298
299
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 297

def 
    @properties['account_sid']
end

#context ⇒ MessagingConfigurationContext

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

Returns:



288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 288

def context
    unless @instance_context
        @instance_context = MessagingConfigurationContext.new(@version , @params['service_sid'], @params['country'])
    end
    @instance_context
end

#country ⇒ String

Returns The [ISO-3166-1](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value ‘all`.

Returns:

  • (String) —

    The [ISO-3166-1](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value ‘all`.



309
310
311
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 309

def country
    @properties['country']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



321
322
323
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 321

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



327
328
329
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 327

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessagingConfigurationInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



340
341
342
343
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 340

def delete

    context.delete
end

#fetch ⇒ MessagingConfigurationInstance

Fetch the MessagingConfigurationInstance

Returns:



348
349
350
351
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 348

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



375
376
377
378
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 375

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

#messaging_service_sid ⇒ String

Returns The SID of the [Messaging Service](www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration.

Returns:



315
316
317
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 315

def messaging_service_sid
    @properties['messaging_service_sid']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/verify/api/service) that the resource is associated with.

Returns:



303
304
305
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 303

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



368
369
370
371
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 368

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

#update(messaging_service_sid: nil) ⇒ MessagingConfigurationInstance

Update the MessagingConfigurationInstance

Parameters:

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

    The SID of the [Messaging Service](www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration.

Returns:



357
358
359
360
361
362
363
364
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 357

def update(
    messaging_service_sid: nil
)

    context.update(
        messaging_service_sid: messaging_service_sid, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



333
334
335
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 333

def url
    @properties['url']
end