Class: Twilio::REST::Verify::V1::ServiceContext

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

Overview

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

Defined Under Namespace

Classes: VerificationCheckInstance, VerificationCheckList, VerificationCheckPage, VerificationInstance, VerificationList, VerificationPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique SID identifier of Verification Service Instance.



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/verify/v1/service.rb', line 182

def initialize(version, sid)
  super(version)

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

  # Dependents
  @verifications = nil
  @verification_checks = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



212
213
214
 
# File 'lib/twilio-ruby/rest/verify/v1/service.rb', line 212

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

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



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

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

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

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

#to_s ⇒ Object

Provide a user friendly representation



267
268
269
270
 
# File 'lib/twilio-ruby/rest/verify/v1/service.rb', line 267

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

#update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A 1-64 character string with friendly name of service

  • code_length (String) (defaults to: :unset) —

    The length of the verification code to be generated. Must be an integer value between 4-10

  • lookup_enabled (Boolean) (defaults to: :unset) —

    Boolean value that indicates if a lookup should be performed with each verification started and associated info returned

Returns:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/twilio-ruby/rest/verify/v1/service.rb', line 225

def update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'CodeLength' => code_length,
      'LookupEnabled' => lookup_enabled,
  })

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

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

#verification_checks ⇒ VerificationCheckList, VerificationCheckContext

Access the verification_checks

Returns:



257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/verify/v1/service.rb', line 257

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

  @verification_checks
end

#verifications ⇒ VerificationList, VerificationContext

Access the verifications

Returns:



245
246
247
248
249
250
251
 
# File 'lib/twilio-ruby/rest/verify/v1/service.rb', line 245

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

  @verifications
end