Class: Twilio::REST::Verify::V2::VerificationAttemptInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/verify/v2/verification_attempt.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ VerificationAttemptInstance

Initialize the VerificationAttemptInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this VerificationAttempt resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 259

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'verification_sid' => payload['verification_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'conversion_status' => payload['conversion_status'],
        'channel' => payload['channel'],
        'price' => payload['price'],
        'channel_data' => payload['channel_data'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Verification resource.

Returns:



301
302
303
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 301

def 
    @properties['account_sid']
end

#channel ⇒ Channels

Returns:

  • (Channels) 


337
338
339
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 337

def channel
    @properties['channel']
end

#channel_data ⇒ Hash

Returns An object containing the channel specific information for an attempt.

Returns:

  • (Hash) —

    An object containing the channel specific information for an attempt.



349
350
351
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 349

def channel_data
    @properties['channel_data']
end

#context ⇒ VerificationAttemptContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 286

def context
    unless @instance_context
        @instance_context = VerificationAttemptContext.new(@version , @params['sid'])
    end
    @instance_context
end

#conversion_status ⇒ ConversionStatus

Returns:

  • (ConversionStatus) 


331
332
333
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 331

def conversion_status
    @properties['conversion_status']
end

#date_created ⇒ Time

Returns The date that this Attempt was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



319
320
321
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 319

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Attempt was updated, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



325
326
327
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 325

def date_updated
    @properties['date_updated']
end

#fetch ⇒ VerificationAttemptInstance

Fetch the VerificationAttemptInstance

Returns:



362
363
364
365
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 362

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



376
377
378
379
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 376

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Verify.V2.VerificationAttemptInstance #{values}>"
end

#price ⇒ Hash

Returns An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](www.twilio.com/en-us/verify/pricing).

Returns:

  • (Hash) —

    An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](www.twilio.com/en-us/verify/pricing).



343
344
345
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 343

def price
    @properties['price']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/verify/api/service) used to generate the attempt.

Returns:



307
308
309
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 307

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The SID that uniquely identifies the verification attempt resource.

Returns:

  • (String) —

    The SID that uniquely identifies the verification attempt resource.



295
296
297
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 295

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



369
370
371
372
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 369

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Verify.V2.VerificationAttemptInstance #{values}>"
end

#url ⇒ String

Returns:

  • (String) 


355
356
357
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 355

def url
    @properties['url']
end

#verification_sid ⇒ String

Returns The SID of the [Verification](www.twilio.com/docs/verify/api/verification) that generated the attempt.

Returns:



313
314
315
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 313

def verification_sid
    @properties['verification_sid']
end