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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb,
lib/twilio-ruby/rest/verify/v2/service/verification.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb,
lib/twilio-ruby/rest/verify/v2/service/verification_check.rb,
lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: MessagingConfigurationContext, MessagingConfigurationInstance, MessagingConfigurationList, MessagingConfigurationPage, RateLimitContext, RateLimitInstance, RateLimitList, RateLimitPage, VerificationCheckInstance, VerificationCheckList, VerificationCheckPage, VerificationContext, VerificationInstance, VerificationList, VerificationPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 196

def initialize(version, sid)
  super(version)

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

  # Dependents
  @verifications = nil
  @verification_checks = nil
  @rate_limits = nil
  @messaging_configurations = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the ServiceInstance



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

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

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 213

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

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

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



345
346
347
348
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 345

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

#messaging_configurations(country = :unset) ⇒ MessagingConfigurationList, MessagingConfigurationContext

Access the messaging_configurations

Raises:

  • (ArgumentError) 


322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 322

def messaging_configurations(country=:unset)
  raise ArgumentError, 'country cannot be nil' if country.nil?

  if country != :unset
    return MessagingConfigurationContext.new(@version, @solution[:sid], country, )
  end

  unless @messaging_configurations
    @messaging_configurations = MessagingConfigurationList.new(@version, service_sid: @solution[:sid], )
  end

  @messaging_configurations
end

#rate_limits(sid = :unset) ⇒ RateLimitList, RateLimitContext

Access the rate_limits

Raises:

  • (ArgumentError) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 304

def rate_limits(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return RateLimitContext.new(@version, @solution[:sid], sid, )
  end

  unless @rate_limits
    @rate_limits = RateLimitList.new(@version, service_sid: @solution[:sid], )
  end

  @rate_limits
end

#to_s ⇒ Object

Provide a user friendly representation



338
339
340
341
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 338

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

#update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 250

def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'CodeLength' => code_length,
      'LookupEnabled' => lookup_enabled,
      'SkipSmsToLandlines' => skip_sms_to_landlines,
      'DtmfInputRequired' => dtmf_input_required,
      'TtsName' => tts_name,
      'Psd2Enabled' => psd2_enabled,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end

#verification_checks ⇒ VerificationCheckList, VerificationCheckContext

Access the verification_checks



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

def verification_checks
  unless @verification_checks
    @verification_checks = VerificationCheckList.new(@version, service_sid: @solution[:sid], )
  end

  @verification_checks
end

#verifications(sid = :unset) ⇒ VerificationList, VerificationContext

Access the verifications

Raises:

  • (ArgumentError) 


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

def verifications(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return VerificationContext.new(@version, @solution[:sid], sid, )
  end

  unless @verifications
    @verifications = VerificationList.new(@version, service_sid: @solution[:sid], )
  end

  @verifications
end