Class: Twilio::REST::Verify::V2::ServiceContext::VerificationCheckInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil) ⇒ VerificationCheckInstance

Initialize the VerificationCheckInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 119

def initialize(version, payload , service_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'],
        'amount' => payload['amount'],
        'payee' => payload['payee'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'sna_attempts_error_codes' => payload['sna_attempts_error_codes'],
    }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource.

Returns:



154
155
156
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 154

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.



184
185
186
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 184

def amount
    @properties['amount']
end

#channel ⇒ Channel

Returns:

  • (Channel) 


166
167
168
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 166

def channel
    @properties['channel']
end

#date_created ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created.

Returns:



196
197
198
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 196

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated.

Returns:



202
203
204
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 202

def date_updated
    @properties['date_updated']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



220
221
222
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 220

def inspect
    "<Twilio.Verify.V2.VerificationCheckInstance>"
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.



190
191
192
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 190

def payee
    @properties['payee']
end

#service_sid ⇒ String

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

Returns:



148
149
150
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 148

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



142
143
144
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 142

def sid
    @properties['sid']
end

#sna_attempts_error_codes ⇒ Array<Hash>

Returns List of error codes as a result of attempting a verification using the sna channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or null if the last channel used wasn’t sna.

Returns:

  • (Array<Hash>) —

    List of error codes as a result of attempting a verification using the sna channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or null if the last channel used wasn’t sna.



208
209
210
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 208

def sna_attempts_error_codes
    @properties['sna_attempts_error_codes']
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.



172
173
174
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 172

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:



160
161
162
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 160

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



214
215
216
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 214

def to_s
    "<Twilio.Verify.V2.VerificationCheckInstance>"
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.



178
179
180
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 178

def valid
    @properties['valid']
end