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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/verification.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the VerificationInstance

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 Verification resource.

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

    The SID of the Call resource to fetch.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 224

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']),
        'sna' => payload['sna'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'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:



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

def 
    @properties['account_sid']
end

#amount ⇒ String

Returns The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

Returns:

  • (String) —

    The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.



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

def amount
    @properties['amount']
end

#channel ⇒ Channel

Returns:

  • (Channel) 


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

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

Returns:



255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 255

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#fetch ⇒ VerificationInstance

Fetch the VerificationInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



382
383
384
385
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 382

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

#lookup ⇒ Hash

Returns Information about the phone number being verified.

Returns:

  • (Hash) —

    Information about the phone number being verified.



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

def lookup
    @properties['lookup']
end

#payee ⇒ String

Returns The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

Returns:

  • (String) —

    The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.



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

def payee
    @properties['payee']
end

#send_code_attempts ⇒ Array<Hash>

Returns An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID.

Returns:

  • (Array<Hash>) —

    An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID.



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

def send_code_attempts
    @properties['send_code_attempts']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/verify/api/service) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Verification resource.

Returns:

  • (String) —

    The unique string that we created to identify the Verification resource.



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

def sid
    @properties['sid']
end

#sna ⇒ Hash

Returns The set of fields used for a silent network auth (‘sna`) verification. Contains a single field with the URL to be invoked to verify the phone number.

Returns:

  • (Hash) —

    The set of fields used for a silent network auth (‘sna`) verification. Contains a single field with the URL to be invoked to verify the phone number.



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

def sna
    @properties['sna']
end

#status ⇒ String

Returns The status of the verification. Can be: ‘pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.

Returns:

  • (String) —

    The status of the verification. Can be: ‘pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.



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

def status
    @properties['status']
end

#to ⇒ String

Returns The phone number or [email](www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](www.twilio.com/docs/glossary/what-e164).

Returns:



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

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



375
376
377
378
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 375

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

#update(status: nil) ⇒ VerificationInstance

Update the VerificationInstance

Parameters:

  • status (Status) (defaults to: nil)

Returns:



364
365
366
367
368
369
370
371
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 364

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the Verification resource.

Returns:

  • (String) —

    The absolute URL of the Verification resource.



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

def url
    @properties['url']
end

#valid ⇒ Boolean

Returns Use "status" instead. Legacy property indicating whether the verification was successful.

Returns:

  • (Boolean) —

    Use "status" instead. Legacy property indicating whether the verification was successful.



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

def valid
    @properties['valid']
end