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

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

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

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

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 269

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, 'country' => country || @properties['country'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

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:



292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 292

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 country code of the country or ‘all`.

Returns:

  • (String) —

    The ISO-3166-1 country code of the country or ‘all`.



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

def country
  @properties['country']
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessagingConfigurationInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



365
366
367
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 365

def delete
  context.delete
end

#fetch ⇒ MessagingConfigurationInstance

Fetch a MessagingConfigurationInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 378

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 used for this configuration.

Returns:

  • (String) —

    The SID of the Messaging Service used for this configuration.



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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



371
372
373
374
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 371

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:



351
352
353
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 351

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.



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

def url
  @properties['url']
end