Class: Twilio::REST::Verify::V2::ServiceContext::MessagingConfigurationContext

Inherits:

InstanceContext

• Object
• InstanceContext
• Twilio::REST::Verify::V2::ServiceContext::MessagingConfigurationContext

Defined in:

lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb

Instance Method Summary

• #delete ⇒ Boolean

  Delete the MessagingConfigurationInstance.

• #fetch ⇒ MessagingConfigurationInstance

  Fetch the MessagingConfigurationInstance.

• #initialize(version, service_sid, country) ⇒ MessagingConfigurationContext constructor

  Initialize the MessagingConfigurationContext.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(messaging_service_sid: nil) ⇒ MessagingConfigurationInstance

  Update the MessagingConfigurationInstance.

Constructor Details

#initialize(version, service_sid, country) ⇒ MessagingConfigurationContext

Initialize the MessagingConfigurationContext

Parameters:

• version (Version) —

  Version that contains the resource

• service_sid (String) —

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

• country (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`.

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

def initialize(version, service_sid, country)
    super(version)

    # Path Solution
    @solution = { service_sid: service_sid, country: country,  }
    @uri = "/Services/#{@solution[:service_sid]}/MessagingConfigurations/#{@solution[:country]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the MessagingConfigurationInstance

Returns:

• (Boolean) —

  True if delete succeeds, false otherwise

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

def delete

    
    @version.delete('DELETE', @uri)
end

#fetch ⇒ MessagingConfigurationInstance

Fetch the MessagingConfigurationInstance

Returns:

• (MessagingConfigurationInstance) —

  Fetched MessagingConfigurationInstance

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

def fetch

    
    payload = @version.fetch('GET', @uri)
    MessagingConfigurationInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        country: @solution[:country],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Verify.V2.MessagingConfigurationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation

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

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Verify.V2.MessagingConfigurationContext #{context}>"
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/messaging/api/service-resource) to be used to send SMS to the country of this configuration.

Returns:

• (MessagingConfigurationInstance) —

  Updated MessagingConfigurationInstance

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

def update(
    messaging_service_sid: nil
)

    data = Twilio::Values.of({
        'MessagingServiceSid' => messaging_service_sid,
    })

    
    payload = @version.update('POST', @uri, data: data)
    MessagingConfigurationInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        country: @solution[:country],
    )
end