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:



183
184
185
186
187
188
189
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 183

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

#deleteBoolean

Deletes the MessagingConfigurationInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise



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

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

#fetchMessagingConfigurationInstance

Fetch a MessagingConfigurationInstance

Returns:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 217

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  MessagingConfigurationInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      country: @solution[:country],
  )
end

#inspectObject

Provide a detailed, user friendly representation



250
251
252
253
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 250

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

#to_sObject

Provide a user friendly representation



243
244
245
246
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 243

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/sms/services/api) to be used to send SMS to the country of this configuration.

Returns:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# 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