Class: Twilio::REST::Verify::V2::ServiceContext::WebhookInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ WebhookInstance

Initialize the WebhookInstance



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 311

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'],
        'friendly_name' => payload['friendly_name'],
        'event_types' => payload['event_types'],
        'status' => payload['status'],
        'version' => payload['version'],
        'webhook_url' => payload['webhook_url'],
        'webhook_method' => payload['webhook_method'],
        '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  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



360
361
362
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 360

def 
    @properties['account_sid']
end

#context ⇒ WebhookContext

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



339
340
341
342
343
344
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 339

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

#date_created ⇒ Time 



402
403
404
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 402

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



408
409
410
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 408

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance



421
422
423
424
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 421

def delete

    context.delete
end

#event_types ⇒ Array<String> 



372
373
374
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 372

def event_types
    @properties['event_types']
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance



429
430
431
432
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 429

def fetch

    context.fetch
end

#friendly_name ⇒ String 



366
367
368
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 366

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



468
469
470
471
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 468

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

#service_sid ⇒ String 



354
355
356
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 354

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



348
349
350
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 348

def sid
    @properties['sid']
end

#status ⇒ Status 



378
379
380
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 378

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



461
462
463
464
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 461

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

#update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset, version: :unset) ⇒ WebhookInstance

Update the WebhookInstance



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 442

def update(
    friendly_name: :unset, 
    event_types: :unset, 
    webhook_url: :unset, 
    status: :unset, 
    version: :unset
)

    context.update(
        friendly_name: friendly_name, 
        event_types: event_types, 
        webhook_url: webhook_url, 
        status: status, 
        version: version, 
    )
end

#url ⇒ String 



414
415
416
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 414

def url
    @properties['url']
end

#version ⇒ Version 



384
385
386
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 384

def version
    @properties['version']
end

#webhook_method ⇒ Methods 



396
397
398
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 396

def webhook_method
    @properties['webhook_method']
end

#webhook_url ⇒ String 



390
391
392
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 390

def webhook_url
    @properties['webhook_url']
end