Class: Twilio::REST::Verify::V2::ServiceContext::VerificationInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Verify::V2::ServiceContext::VerificationInstance

Defined in:

lib/twilio-ruby/rest/verify/v2/service/verification.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #amount ⇒ String

  The amount of the associated PSD2 compliant transaction.

• #channel ⇒ verification.Channel

  The verification method used.

• #context ⇒ VerificationContext

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

• #date_created ⇒ Time

  The RFC 2822 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The RFC 2822 date and time in GMT when the resource was last updated.

• #fetch ⇒ VerificationInstance

  Fetch the VerificationInstance.

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

  Initialize the VerificationInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #lookup ⇒ Hash

  Information about the phone number being verified.

• #payee ⇒ String

  The payee of the associated PSD2 compliant transaction.

• #send_code_attempts ⇒ Hash

  An array of verification attempt objects.

• #service_sid ⇒ String

  The SID of the Service that the resource is associated with.

• #sid ⇒ String

  The unique string that identifies the resource.

• #status ⇒ String

  The status of the verification resource.

• #to ⇒ String

  The phone number or email being verified.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(status: nil) ⇒ VerificationInstance

  Update the VerificationInstance.

• #url ⇒ String

  The absolute URL of the Verification resource.

• #valid ⇒ Boolean

  Whether the verification was successful.

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ VerificationInstance

Initialize the VerificationInstance

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 199

def initialize(version, payload, service_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'service_sid' => payload['service_sid'],
      'account_sid' => payload['account_sid'],
      'to' => payload['to'],
      'channel' => payload['channel'],
      'status' => payload['status'],
      'valid' => payload['valid'],
      'lookup' => payload['lookup'],
      'amount' => payload['amount'],
      'payee' => payload['payee'],
      'send_code_attempts' => payload['send_code_attempts'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 250

def account_sid
  @properties['account_sid']
end

#amount ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 286

def amount
  @properties['amount']
end

#channel ⇒ verification.Channel

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 262

def channel
  @properties['channel']
end

#context ⇒ VerificationContext

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/service/verification.rb', line 229

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 304

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 310

def date_updated
  @properties['date_updated']
end

#fetch ⇒ VerificationInstance

Fetch the VerificationInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 345

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

#lookup ⇒ Hash

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 280

def lookup
  @properties['lookup']
end

#payee ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 292

def payee
  @properties['payee']
end

#send_code_attempts ⇒ Hash

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 298

def send_code_attempts
  @properties['send_code_attempts']
end

#service_sid ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 244

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 238

def sid
  @properties['sid']
end

#status ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 268

def status
  @properties['status']
end

#to ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 256

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 338

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

#update(status: nil) ⇒ VerificationInstance

Update the VerificationInstance

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 325

def update(status: nil)
  context.update(status: status, )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 316

def url
  @properties['url']
end

#valid ⇒ Boolean

# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 274

def valid
  @properties['valid']
end