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

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

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 285

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

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

Returns:



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

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

Returns:



313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 313

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

#date_created ⇒ Time

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#event_types ⇒ Array<String>

Returns The array of events that this Webhook is subscribed to. Possible event types: ‘*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`.

Returns:

  • (Array<String>) —

    The array of events that this Webhook is subscribed to. Possible event types: ‘*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`



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

def event_types
    @properties['event_types']
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the webhook. **This value should not contain PII.**.

Returns:

  • (String) —

    The string that you assigned to describe the webhook. **This value should not contain PII.**



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



442
443
444
445
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 442

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

#service_sid ⇒ String

Returns The unique SID identifier of the Service.

Returns:

  • (String) —

    The unique SID identifier of the Service.



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



435
436
437
438
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 435

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

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the webhook. **This value should not contain PII.**

  • event_types (Array[String]) (defaults to: :unset) —

    The array of events that this Webhook is subscribed to. Possible event types: ‘*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`

  • webhook_url (String) (defaults to: :unset) —

    The URL associated with this Webhook.

  • status (Status) (defaults to: :unset)
  • version (Version) (defaults to: :unset)

Returns:



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 416

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

Returns The absolute URL of the Webhook resource.

Returns:

  • (String) —

    The absolute URL of the Webhook resource.



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

def url
    @properties['url']
end

#version ⇒ Version

Returns:



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

def version
    @properties['version']
end

#webhook_method ⇒ Methods

Returns:

  • (Methods) 


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

def webhook_method
    @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The URL associated with this Webhook.

Returns:

  • (String) —

    The URL associated with this Webhook.



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

def webhook_url
    @properties['webhook_url']
end