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

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

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

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

    The Twilio-provided string that uniquely identifies the Verification resource to fetch.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 196

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

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#amount ⇒ String

Returns The amount of the associated PSD2 compliant transaction.

Returns:

  • (String) —

    The amount of the associated PSD2 compliant transaction.



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

def amount
  @properties['amount']
end

#channel ⇒ verification.Channel

Returns The verification method used.

Returns:

  • (verification.Channel) —

    The verification method used.



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

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:



226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 226

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ VerificationInstance

Fetch the VerificationInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def lookup
  @properties['lookup']
end

#payee ⇒ String

Returns The payee of the associated PSD2 compliant transaction.

Returns:

  • (String) —

    The payee of the associated PSD2 compliant transaction



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

def payee
  @properties['payee']
end

#send_code_attempts ⇒ Hash

Returns An array of verification attempt objects.

Returns:

  • (Hash) —

    An array of verification attempt objects.



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

def send_code_attempts
  @properties['send_code_attempts']
end

#service_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status ⇒ String

Returns The status of the verification resource.

Returns:

  • (String) —

    The status of the verification resource



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

def status
  @properties['status']
end

#to ⇒ String

Returns The phone number or email being verified.

Returns:

  • (String) —

    The phone number or email being verified



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 (verification.Status) (defaults to: nil) —

    The new status of the resource. Can be: canceled or approved.

Returns:



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

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



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

def url
  @properties['url']
end

#valid ⇒ Boolean

Returns Whether the verification was successful.

Returns:

  • (Boolean) —

    Whether the verification was successful



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

def valid
  @properties['valid']
end