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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 211

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_sidString



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

def 
    @properties['account_sid']
end

#amountString



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

def amount
    @properties['amount']
end

#channelChannel



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

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



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

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

#date_createdTime



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

def date_created
    @properties['date_created']
end

#date_updatedTime



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

def date_updated
    @properties['date_updated']
end

#fetchVerificationInstance

Fetch the VerificationInstance



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

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



369
370
371
372
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 369

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

#lookupHash



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

def lookup
    @properties['lookup']
end

#payeeString



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

def payee
    @properties['payee']
end

#send_code_attemptsArray<Hash>



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

def send_code_attempts
    @properties['send_code_attempts']
end

#service_sidString



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

def service_sid
    @properties['service_sid']
end

#sidString



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

def sid
    @properties['sid']
end

#snaHash



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

def sna
    @properties['sna']
end

#statusString



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

def status
    @properties['status']
end

#toString



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

def to
    @properties['to']
end

#to_sObject

Provide a user friendly representation



362
363
364
365
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 362

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

#update(status: nil) ⇒ VerificationInstance

Update the VerificationInstance



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

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#urlString



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

def url
    @properties['url']
end

#validBoolean



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

def valid
    @properties['valid']
end