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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Verify::V2::VerificationAttemptInstance

Defined in:

lib/twilio-ruby/rest/verify/v2/verification_attempt.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #channel ⇒ Channels
• #channel_data ⇒ Hash

  An object containing the channel specific information for an attempt.

• #context ⇒ VerificationAttemptContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #conversion_status ⇒ ConversionStatus
• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #fetch ⇒ VerificationAttemptInstance

  Fetch the VerificationAttemptInstance.

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

  Initialize the VerificationAttemptInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #price ⇒ Hash

  An object containing the charge for this verification attempt related to the channel costs and the currency used.

• #service_sid ⇒ String

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

• #sid ⇒ String

  The SID that uniquely identifies the verification attempt resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String
• #verification_sid ⇒ String

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

Constructor Details

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

Initialize the VerificationAttemptInstance

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

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

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

def account_sid
    @properties['account_sid']
end

#channel ⇒ Channels

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

def channel
    @properties['channel']
end

#channel_data ⇒ Hash

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

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

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

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

#conversion_status ⇒ ConversionStatus

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

def conversion_status
    @properties['conversion_status']
end

#date_created ⇒ Time

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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
    @properties['date_updated']
end

#fetch ⇒ VerificationAttemptInstance

Fetch the VerificationAttemptInstance

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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#price ⇒ Hash

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

def price
    @properties['price']
end

#service_sid ⇒ String

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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
    @properties['url']
end

#verification_sid ⇒ String

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

def verification_sid
    @properties['verification_sid']
end