Class: Twilio::REST::Verify::V2::ServiceContext::VerificationCheckInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Verify::V2::ServiceContext::VerificationCheckInstance
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service/verification_check.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource.
-
#amount ⇒ String
The amount of the associated PSD2 compliant transaction.
- #channel ⇒ Channel
-
#date_created ⇒ Time
The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created.
-
#date_updated ⇒ Time
The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated.
-
#initialize(version, payload, service_sid: nil) ⇒ VerificationCheckInstance
constructor
Initialize the VerificationCheckInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#payee ⇒ String
The payee of the associated PSD2 compliant transaction.
-
#service_sid ⇒ String
The SID of the [Service](www.twilio.com/docs/verify/api/service) the resource is associated with.
-
#sid ⇒ String
The unique string that we created to identify the VerificationCheck resource.
-
#sna_attempts_error_codes ⇒ Array<Hash>
List of error codes as a result of attempting a verification using the ‘sna` channel.
-
#status ⇒ String
The status of the verification.
-
#to ⇒ String
The phone number or [email](www.twilio.com/docs/verify/email) being verified.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#valid ⇒ Boolean
Use "status" instead.
Constructor Details
#initialize(version, payload, service_sid: nil) ⇒ VerificationCheckInstance
Initialize the VerificationCheckInstance
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 113 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.
148 149 150 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 148 def account_sid @properties['account_sid'] end |
#amount ⇒ String
Returns The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
178 179 180 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 178 def amount @properties['amount'] end |
#channel ⇒ Channel
160 161 162 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 160 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.
190 191 192 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 190 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.
196 197 198 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 196 def date_updated @properties['date_updated'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
214 215 216 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 214 def inspect "<Twilio.Verify.V2.VerificationCheckInstance>" end |
#payee ⇒ String
Returns The payee 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 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.
142 143 144 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 142 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The unique string that we created to identify the VerificationCheck resource.
136 137 138 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 136 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`.
202 203 204 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 202 def sna_attempts_error_codes @properties['sna_attempts_error_codes'] end |
#status ⇒ String
Returns The status of the verification. Can be: ‘pending`, `approved`, or `canceled`.
166 167 168 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 166 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).
154 155 156 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 154 def to @properties['to'] end |
#to_s ⇒ Object
Provide a user friendly representation
208 209 210 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 208 def to_s "<Twilio.Verify.V2.VerificationCheckInstance>" end |
#valid ⇒ Boolean
Returns Use "status" instead. Legacy property indicating whether the verification was successful.
172 173 174 |
# File 'lib/twilio-ruby/rest/verify/v2/service/verification_check.rb', line 172 def valid @properties['valid'] end |