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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/entity.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb

Defined Under Namespace

Classes: ChallengeContext, ChallengeInstance, ChallengeInstanceMetadata, ChallengeList, ChallengeListResponse, ChallengePage, ChallengePageMetadata, FactorContext, FactorInstance, FactorInstanceMetadata, FactorList, FactorListResponse, FactorPage, FactorPageMetadata, NewFactorInstance, NewFactorList, NewFactorListResponse, NewFactorPage, NewFactorPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, identity) ⇒ EntityContext

Initialize the EntityContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The unique SID identifier of the Service.

  • identity (String) —

    The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user’s UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.



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

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

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

    # Dependents
    @new_factors = nil
    @factors = nil
    @challenges = nil
end

Instance Method Details

#challenges(sid = :unset) ⇒ ChallengeList, ChallengeContext

Access the challenges

Returns:

Raises:

  • (ArgumentError) 


353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 353

def challenges(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

    unless @challenges
        @challenges = ChallengeList.new(
            @version, service_sid: @solution[:service_sid], identity: @solution[:identity], )
    end

 @challenges
end

#delete ⇒ Boolean

Delete the EntityInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the EntityInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 257

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      entity_instance = EntityInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      EntityInstanceMetadata.new(@version, entity_instance, response.headers, response.status_code)
end

#factors(sid = :unset) ⇒ FactorList, FactorContext

Access the factors

Returns:

Raises:

  • (ArgumentError) 


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 334

def factors(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

    unless @factors
        @factors = FactorList.new(
            @version, service_sid: @solution[:service_sid], identity: @solution[:identity], )
    end

 @factors
end

#fetch ⇒ EntityInstance

Fetch the EntityInstance

Returns:



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

def fetch

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

#fetch_with_metadata ⇒ EntityInstance

Fetch the EntityInstanceMetadata

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 296

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 378

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

#new_factors ⇒ NewFactorList, NewFactorContext

Access the new_factors

Returns:



323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 323

def new_factors
  unless @new_factors
    @new_factors = NewFactorList.new(
            @version, service_sid: @solution[:service_sid], identity: @solution[:identity], )
  end
  @new_factors
end

#to_s ⇒ Object

Provide a user friendly representation



371
372
373
374
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity.rb', line 371

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