class Twilio::REST::Verify::V2::ServiceContext::VerificationInstance
Public Class Methods
Initialize the VerificationInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] service_sid
The SID of the
{Service}[https://www.twilio.com/docs/verify/api/service] the resource is associated with.
@param [String] sid The Twilio-provided string that uniquely identifies the
Verification resource to fetch.
@return [VerificationInstance] VerificationInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 201 def initialize(version, payload, service_sid: nil, sid: nil) 202 super(version) 203 204 # Marshaled Properties 205 @properties = { 206 'sid' => payload['sid'], 207 'service_sid' => payload['service_sid'], 208 'account_sid' => payload['account_sid'], 209 'to' => payload['to'], 210 'channel' => payload['channel'], 211 'status' => payload['status'], 212 'valid' => payload['valid'], 213 'lookup' => payload['lookup'], 214 'amount' => payload['amount'], 215 'payee' => payload['payee'], 216 'send_code_attempts' => payload['send_code_attempts'], 217 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 218 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 219 'url' => payload['url'], 220 } 221 222 # Context 223 @instance_context = nil 224 @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], } 225 end
Public Instance Methods
@return [String] The SID of the Account that created the resource
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 252 def account_sid 253 @properties['account_sid'] 254 end
@return [String] The amount of the associated PSD2 compliant transaction.
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 288 def amount 289 @properties['amount'] 290 end
@return [verification.Channel] The verification method used.
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 264 def channel 265 @properties['channel'] 266 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [VerificationContext] VerificationContext
for this VerificationInstance
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 231 def context 232 unless @instance_context 233 @instance_context = VerificationContext.new(@version, @params['service_sid'], @params['sid'], ) 234 end 235 @instance_context 236 end
@return [Time] The RFC 2822 date and time in GMT when the resource was created
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 306 def date_created 307 @properties['date_created'] 308 end
@return [Time] The RFC 2822 date and time in GMT when the resource was last updated
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 312 def date_updated 313 @properties['date_updated'] 314 end
Fetch the VerificationInstance
@return [VerificationInstance] Fetched VerificationInstance
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 334 def fetch 335 context.fetch 336 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 347 def inspect 348 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 349 "<Twilio.Verify.V2.VerificationInstance #{values}>" 350 end
@return [Hash] Information about the phone number being verified
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 282 def lookup 283 @properties['lookup'] 284 end
@return [String] The payee of the associated PSD2 compliant transaction
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 294 def payee 295 @properties['payee'] 296 end
@return [Array] An array of verification attempt objects.
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 300 def send_code_attempts 301 @properties['send_code_attempts'] 302 end
@return [String] The SID of the Service that the resource is associated with
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 246 def service_sid 247 @properties['service_sid'] 248 end
@return [String] The unique string that identifies the resource
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 240 def sid 241 @properties['sid'] 242 end
@return [String] The status of the verification resource
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 270 def status 271 @properties['status'] 272 end
@return [String] The phone number or email being verified
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 258 def to 259 @properties['to'] 260 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 340 def to_s 341 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 342 "<Twilio.Verify.V2.VerificationInstance #{values}>" 343 end
Update the VerificationInstance
@param [verification.Status] status The new status of the resource. Can be:
`canceled` or `approved`.
@return [VerificationInstance] Updated VerificationInstance
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 327 def update(status: nil) 328 context.update(status: status, ) 329 end
@return [String] The absolute URL of the Verification resource
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 318 def url 319 @properties['url'] 320 end
@return [Boolean] Whether the verification was successful
# File lib/twilio-ruby/rest/verify/v2/service/verification.rb 276 def valid 277 @properties['valid'] 278 end