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 the resource is associated with.

  • sid (String) (defaults to: nil)

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


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 203

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#amountString

Returns The amount of the associated PSD2 compliant transaction.

Returns:

  • (String)

    The amount of the associated PSD2 compliant transaction.


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

def amount
  @properties['amount']
end

#channelverification.Channel

Returns The verification method used.

Returns:

  • (verification.Channel)

    The verification method used.


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

def channel
  @properties['channel']
end

#contextVerificationContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


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

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#fetchVerificationInstance

Fetch the VerificationInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#lookupHash

Returns Information about the phone number being verified.

Returns:

  • (Hash)

    Information about the phone number being verified


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

def lookup
  @properties['lookup']
end

#payeeString

Returns The payee of the associated PSD2 compliant transaction.

Returns:

  • (String)

    The payee of the associated PSD2 compliant transaction


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

def payee
  @properties['payee']
end

#send_code_attemptsArray[Hash]

Returns An array of verification attempt objects.

Returns:

  • (Array[Hash])

    An array of verification attempt objects.


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

def send_code_attempts
  @properties['send_code_attempts']
end

#service_sidString

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


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statusString

Returns The status of the verification resource.

Returns:

  • (String)

    The status of the verification resource


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

def status
  @properties['status']
end

#toString

Returns The phone number or email being verified.

Returns:

  • (String)

    The phone number or email being verified


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

def to
  @properties['to']
end

#to_sObject

Provide a user friendly representation


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

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:


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

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

#urlString

Returns The absolute URL of the Verification resource.

Returns:

  • (String)

    The absolute URL of the Verification resource


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

def url
  @properties['url']
end

#validBoolean

Returns Whether the verification was successful.

Returns:

  • (Boolean)

    Whether the verification was successful


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

def valid
  @properties['valid']
end