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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ VerificationContext

Initialize the VerificationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the verification [Service](www.twilio.com/docs/verify/api/service) to update the resource from.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Verification resource to update.



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

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

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

    
end

Instance Method Details

#fetch ⇒ VerificationInstance

Fetch the VerificationInstance

Returns:



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

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    VerificationInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ VerificationInstance

Fetch the VerificationInstanceMetadata

Returns:



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

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    verification_instance = VerificationInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    VerificationInstanceMetadata.new(
        @version,
        verification_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



332
333
334
335
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 332

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

#update(status: nil) ⇒ VerificationInstance

Update the VerificationInstance

Parameters:

  • status (Status) (defaults to: nil)

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 273

def update(
    status: nil
)

    data = Twilio::Values.of({
        'Status' => status,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    VerificationInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(status: nil) ⇒ VerificationInstance

Update the VerificationInstanceMetadata

Parameters:

  • status (Status) (defaults to: nil)

Returns:



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 300

def update_with_metadata(
  status: nil
)

    data = Twilio::Values.of({
        'Status' => status,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    verification_instance = VerificationInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    VerificationInstanceMetadata.new(
        @version,
        verification_instance,
        response.headers,
        response.status_code
    )
end