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

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

Instance Method Summary collapse

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 that the resource is associated with.

  • country (String) —

    The ISO-3166-1 country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.


176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 176

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


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

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

#fetch ⇒ MessagingConfigurationInstance

Fetch the MessagingConfigurationInstance

Returns:


206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 206

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


233
234
235
236
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 233

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

#to_s ⇒ Object

Provide a user friendly representation


226
227
228
229
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 226

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 to be used to send SMS to the country of this configuration.

Returns:


190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 190

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